Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Components ¶ added in v0.1.1
type Components struct {
SecuritySchemes map[string]SecurityScheme `json:"securitySchemes" yaml:"securitySchemes"`
}
type Document ¶
type Document struct {
OpenAPI string `json:"openapi" yaml:"openapi"`
Info Info `json:"info" yaml:"info"`
Servers []Server `json:"servers" yaml:"servers"`
Paths map[string]PathItem `json:"paths" yaml:"paths"`
Components Components `json:"components" yaml:"components"`
Security []SecurityRequirement `json:"security" yaml:"security"`
SecuritySet bool `json:"-" yaml:"-"`
}
func (*Document) Operations ¶
func (d *Document) Operations() []OperationView
type Operation ¶
type Operation struct {
OperationID string `json:"operationId" yaml:"operationId"`
Summary string `json:"summary" yaml:"summary"`
Description string `json:"description" yaml:"description"`
Parameters []Parameter `json:"parameters" yaml:"parameters"`
RequestBody *RequestBody `json:"requestBody" yaml:"requestBody"`
Security []SecurityRequirement `json:"security" yaml:"security"`
SecuritySet bool `json:"-" yaml:"-"`
}
type OperationView ¶
type PathItem ¶
type PathItem struct {
Summary string `json:"summary" yaml:"summary"`
Description string `json:"description" yaml:"description"`
Parameters []Parameter `json:"parameters" yaml:"parameters"`
Get *Operation `json:"get" yaml:"get"`
Post *Operation `json:"post" yaml:"post"`
Put *Operation `json:"put" yaml:"put"`
Patch *Operation `json:"patch" yaml:"patch"`
Delete *Operation `json:"delete" yaml:"delete"`
}
type RequestBody ¶
type Schema ¶
type Schema struct {
Type string `json:"type" yaml:"type"`
Format string `json:"format" yaml:"format"`
Description string `json:"description" yaml:"description"`
Required []string `json:"required" yaml:"required"`
Properties map[string]Schema `json:"properties" yaml:"properties"`
Items *Schema `json:"items" yaml:"items"`
Enum []any `json:"enum" yaml:"enum"`
AdditionalProperties any `json:"additionalProperties" yaml:"additionalProperties"`
}
type SecurityRequirement ¶ added in v0.4.0
type SecurityScheme ¶ added in v0.1.1
Click to show internal directories.
Click to hide internal directories.