...

Source file src/github.com/google/gnostic-models/openapiv2/document.go

Documentation: github.com/google/gnostic-models/openapiv2

     1  // Copyright 2020 Google LLC. All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //    http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package openapi_v2
    16  
    17  import (
    18  	"gopkg.in/yaml.v3"
    19  
    20  	"github.com/google/gnostic-models/compiler"
    21  )
    22  
    23  // ParseDocument reads an OpenAPI v2 description from a YAML/JSON representation.
    24  func ParseDocument(b []byte) (*Document, error) {
    25  	info, err := compiler.ReadInfoFromBytes("", b)
    26  	if err != nil {
    27  		return nil, err
    28  	}
    29  	root := info.Content[0]
    30  	return NewDocument(root, compiler.NewContextWithExtensions("$root", root, nil, nil))
    31  }
    32  
    33  // YAMLValue produces a serialized YAML representation of the document.
    34  func (d *Document) YAMLValue(comment string) ([]byte, error) {
    35  	rawInfo := d.ToRawInfo()
    36  	rawInfo = &yaml.Node{
    37  		Kind:        yaml.DocumentNode,
    38  		Content:     []*yaml.Node{rawInfo},
    39  		HeadComment: comment,
    40  	}
    41  	return yaml.Marshal(rawInfo)
    42  }
    43  

View as plain text