openapi

Documentation

Index

• type ExternalDocs
• type OpenAPI
  • func LoadAPISpec(openAPIFile string) (*OpenAPI, error)
  • func (o *OpenAPI) GetChildren() map[string]tree.NodeTraverser
  • func (o *OpenAPI) GetRef() string
  • func (o *OpenAPI) SetChild(i string, child tree.NodeTraverser)

Types

type ExternalDocs

type ExternalDocs struct {
	Description string `yaml:"description"`
	Url         string `yaml:"url"`
}

ExternalDocs is a programmatic representation of the External Docs object defined here: https://swagger.io/specification/#external-documentation-object

type OpenAPI

type OpenAPI struct {
	tree.Node
	OpenAPI    string `yaml:"openapi"` // TODO it's unclear what this refers to
	Info       info.Info
	Servers    []servers.Server
	Paths      map[string]*path.Item
	Components components.Components
}

OpenAPI is a programmatic representation of the OpenApi Document object defined here: https://swagger.io/specification/#openapi-object

func LoadAPISpec

func LoadAPISpec(openAPIFile string) (*OpenAPI, error)

func (*OpenAPI) GetChildren

func (o *OpenAPI) GetChildren() map[string]tree.NodeTraverser

func (*OpenAPI) GetRef

func (o *OpenAPI) GetRef() string

func (*OpenAPI) SetChild

func (o *OpenAPI) SetChild(i string, child tree.NodeTraverser)