path

Documentation

Index

• type Item
  • func (p *Item) GetBasePath() string
  • func (p *Item) GetChildren() map[string]tree.NodeTraverser
  • func (p *Item) GetPath() string
  • func (p *Item) GetRef() string
  • func (p *Item) Operations() map[string]tree.NodeTraverser
  • func (p *Item) SetChild(i string, child tree.NodeTraverser)

Types

type Item

type Item struct {
	tree.Node
	Ref         string `yaml:"$ref"` // must be defined in the format of a PathItem object
	Summary     string
	Description string
	Get         *operation.Operation
	Post        *operation.Operation
	Patch       *operation.Operation
	Delete      *operation.Operation
	Parameters  []parameter.Parameter
}

Item is a programmatic representation of the Path Item object defined here: https://swagger.io/specification/#path-item-object

func (*Item) GetBasePath

func (p *Item) GetBasePath() string

func (*Item) GetChildren

func (p *Item) GetChildren() map[string]tree.NodeTraverser

func (*Item) GetPath

func (p *Item) GetPath() string

func (*Item) GetRef

func (p *Item) GetRef() string

func (*Item) Operations

func (p *Item) Operations() map[string]tree.NodeTraverser

Operations is public as it's called by the templater before rendering output

func (*Item) SetChild

func (p *Item) SetChild(i string, child tree.NodeTraverser)