parameter

Documentation

Index

• type Parameter
  • func (p *Parameter) GetChildren() map[string]tree.NodeTraverser
  • func (p *Parameter) GetName() []string
  • func (p *Parameter) GetParamName() []string
  • func (p *Parameter) GetRef() string
  • func (p *Parameter) SetChild(_ string, t tree.NodeTraverser)

Types

type Parameter

type Parameter struct {
	tree.Node
	Ref             string         `yaml:"$ref"`
	ParamName       string         `yaml:"name"`
	In              string         `yaml:"in"`
	Description     string         `yaml:"description"`
	Required        bool           `yaml:"required"`
	Deprecated      bool           `yaml:"deprecated"`
	AllowEmptyValue bool           `yaml:"allowEmptyValue"`
	Schema          *schema.Schema // Acts as alternative description of param
}

Parameter is a programmatic representation of the Parameter object defined here: https://swagger.io/specification/#parameter-object

func (*Parameter) GetChildren

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

func (*Parameter) GetName

func (p *Parameter) GetName() []string

func (*Parameter) GetParamName

func (p *Parameter) GetParamName() []string

func (*Parameter) GetRef

func (p *Parameter) GetRef() string

func (*Parameter) SetChild

func (p *Parameter) SetChild(_ string, t tree.NodeTraverser)