response

Documentation

Index

• func BuildResponse(comments in.SwagifyComment) map[string]Response
• func ParseOperationResponseLines(lines []string) map[string]Response
• type Content
• type RefSchema
• type Response

Functions

func BuildResponse

func BuildResponse(comments in.SwagifyComment) map[string]Response

go-swagify

@@response: <name or status code> @@ref: (optional) schema reference @@desc: (required, if @@ref not used) @@content_name: (not required if @@ref is used, else optional) application/json, etc @@content_ref: (not required if @@ref is used, else optional) schema reference ... can repeat @@content_*

func ParseOperationResponseLines

func ParseOperationResponseLines(lines []string) map[string]Response

called by operation

Types

type Content

type Content struct {
	RefSchema `json:"schema" yaml:"schema"`
}

type RefSchema

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

type Response

type Response struct {
	Ref         string             `json:"$ref,omitempty" yaml:"$ref,omitempty"`
	Description string             `json:"description,omitempty" yaml:"description,omitempty"`
	Content     map[string]Content `json:"content,omitempty" yaml:"content,omitempty"`
}