document

package
v0.0.0-...-fff57cb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 10, 2023 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Document

type Document struct {
	FilePath     string                `json:"-" yaml:"-"`
	Openapi      string                `json:"openapi,omitempty" yaml:"openapi,omitempty"`
	Info         info.Info             `json:"info,omitempty" yaml:"info,omitempty"`
	Servers      []server.Server       `json:"servers,omitempty" yaml:"servers,omitempty"`
	Paths        map[string]path.Path  `json:"paths,omitempty" yaml:"paths,omitempty"`
	Components   *component.Components `json:"components,omitempty" yaml:"components,omitempty"`
	Security     *json.RawMessage      `json:"security,omitempty" yaml:"security,omitempty"`
	Tags         []tag.Tag             `json:"tags,omitempty" yaml:"tags,omitempty"`
	ExternalDocs *json.RawMessage      `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`
}

func NewDocument

func NewDocument(filepath string) *Document

func (*Document) GetComponentExample

func (doc *Document) GetComponentExample(c string) (component.Example, error)

func (*Document) GetOperationsByTag

func (doc *Document) GetOperationsByTag(tag string) (ops []operation.PathOperation)

func (*Document) Save

func (doc *Document) Save()

func (*Document) UpdateInfo

func (doc *Document) UpdateInfo(info info.Info)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL