methods

Documentation

Index

• type DeletePathSchema
  • func NewDeletePathSchema(operationID, summary, description string, tags []string, ...) *DeletePathSchema
  • func (d *DeletePathSchema) ToYaml() (string, error)
• type GetPathSchema
  • func NewGetPathSchema(operationID, summary, description string, tags []string, ...) *GetPathSchema
  • func (p *GetPathSchema) ToYaml() (string, error)
• type PathRoot
• type PostPathSchema
  • func NewPostPathSchema(operationID, summary, description string, tags []string, ...) *PostPathSchema
  • func (p *PostPathSchema) ToYaml() (string, error)
• type PutPathSchema
  • func NewPutPathSchema(operationID, summary, description string, tags []string, ...) *PutPathSchema
  • func (p *PutPathSchema) ToYaml() (string, error)

Types

type DeletePathSchema

type DeletePathSchema struct {
	OperationID string               `yaml:"operationId"`
	Summary     string               `yaml:"summary,omitempty"`
	Description string               `yaml:"description,omitempty"`
	Tags        []string             `yaml:"tags,omitempty"`
	Security    []generate.Security  `yaml:"security,omitempty"`
	RequestBody generate.RequestBody `yaml:"requestBody,omitempty"`
	Parameters  generate.Parameters  `yaml:"parameters,omitempty"`
	Responses   generate.Responses   `yaml:"responses"`
}

func NewDeletePathSchema

func NewDeletePathSchema(operationID, summary, description string, tags []string, security []generate.Security, requestBody generate.RequestBody, parameters generate.Parameters, responses generate.Responses) *DeletePathSchema

func (*DeletePathSchema) ToYaml

func (d *DeletePathSchema) ToYaml() (string, error)

type GetPathSchema

type GetPathSchema struct {
	OperationID string              `yaml:"operationId"`
	Summary     string              `yaml:"summary,omitempty"`
	Description string              `yaml:"description,omitempty"`
	Tags        []string            `yaml:"tags,omitempty"`
	Security    []generate.Security `yaml:"security,omitempty"`
	Parameters  generate.Parameters `yaml:"parameters,omitempty"`
	Responses   generate.Responses  `yaml:"responses"`
}

func NewGetPathSchema

func NewGetPathSchema(operationID, summary, description string, tags []string, security []generate.Security, parameters generate.Parameters, responses generate.Responses) *GetPathSchema

func (*GetPathSchema) ToYaml

func (p *GetPathSchema) ToYaml() (string, error)

type PathRoot

type PathRoot struct {
	Get    GetPathSchema    `yaml:"get,omitempty"`
	Post   PostPathSchema   `yaml:"post,omitempty"`
	Put    PutPathSchema    `yaml:"put,omitempty"`
	Delete DeletePathSchema `yaml:"delete,omitempty"`
}

type PostPathSchema

type PostPathSchema struct {
	OperationID string               `yaml:"operationId"`
	Summary     string               `yaml:"summary,omitempty"`
	Description string               `yaml:"description,omitempty"`
	Tags        []string             `yaml:"tags,omitempty"`
	Security    []generate.Security  `yaml:"security,omitempty"`
	RequestBody generate.RequestBody `yaml:"requestBody,omitempty"`
	Parameters  generate.Parameters  `yaml:"parameters,omitempty"`
	Responses   generate.Responses   `yaml:"responses"`
}

func NewPostPathSchema

func NewPostPathSchema(operationID, summary, description string, tags []string, security []generate.Security, requestBody generate.RequestBody, parameters generate.Parameters, responses generate.Responses) *PostPathSchema

func (*PostPathSchema) ToYaml

func (p *PostPathSchema) ToYaml() (string, error)

type PutPathSchema

type PutPathSchema struct {
	OperationID string               `yaml:"operationId"`
	Summary     string               `yaml:"summary,omitempty"`
	Description string               `yaml:"description,omitempty"`
	Tags        []string             `yaml:"tags,omitempty"`
	Security    []generate.Security  `yaml:"security,omitempty"`
	RequestBody generate.RequestBody `yaml:"requestBody,omitempty"`
	Parameters  generate.Parameters  `yaml:"parameters,omitempty"`
	Responses   generate.Responses   `yaml:"responses"`
}

func NewPutPathSchema

func NewPutPathSchema(operationID, summary, description string, tags []string, security []generate.Security, requestBody generate.RequestBody, parameters generate.Parameters, responses generate.Responses) *PutPathSchema

func (*PutPathSchema) ToYaml

func (p *PutPathSchema) ToYaml() (string, error)