path

Documentation

Index

• func BuildPaths(comments in.SwagifyComment, operationBuilds map[string]opr.OperationBuild) map[string]Path
• type Path

Functions

func BuildPaths

func BuildPaths(comments in.SwagifyComment, operationBuilds map[string]opr.OperationBuild) map[string]Path

go-swagify

@@path: <path url> @@summary: (optional) @@description: (optional) @@parameters.ref: (optional) semicolon(;) list of ref parameter names

Types

type Path

type Path struct {
	Summary     string             `json:"summary,omitempty" yaml:"summary,omitempty"`
	Description string             `json:"description,omitempty" yaml:"description,omitempty"`
	Parameters  []par.ParameterRef `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	Get         *opr.Operation     `json:"get,omitempty" yaml:"get,omitempty"`
	Put         *opr.Operation     `json:"put,omitempty" yaml:"put,omitempty"`
	Post        *opr.Operation     `json:"post,omitempty" yaml:"post,omitempty"`
	Delete      *opr.Operation     `json:"delete,omitempty" yaml:"delete,omitempty"`
	Options     *opr.Operation     `json:"options,omitempty" yaml:"options,omitempty"`
	Head        *opr.Operation     `json:"head,omitempty" yaml:"head,omitempty"`
	Patch       *opr.Operation     `json:"patch,omitempty" yaml:"patch,omitempty"`
	Trace       *opr.Operation     `json:"trace,omitempty" yaml:"trace,omitempty"`
}