parameter

Documentation

Index

• func BuildParameters(comments in.SwagifyComment) map[string]Parameter
• type Parameter
  • func (p *Parameter) ValidateIn()
• type ParameterRef

Functions

func BuildParameters

func BuildParameters(comments in.SwagifyComment) map[string]Parameter

Types

type Parameter

type Parameter struct {
	Name        string              `json:"name" yaml:"name"`
	In          string              `json:"in" yaml:"in"`
	Description string              `json:"description,omitempty" yaml:"description,omitempty"`
	Required    bool                `json:"required,omitempty" yaml:"required,omitempty"`
	Schema      *sch.SchemaProperty `json:"schema,omitempty" yaml:"schema,omitempty"`
}

func (*Parameter) ValidateIn

func (p *Parameter) ValidateIn()

type ParameterRef

type ParameterRef struct {
	Ref string `json:"$ref" yaml:"$ref"`
}