Documentation
¶
Index ¶
Constants ¶
View Source
const ( DefinitionsLabel = "definitions" SecurityDefinitionsLabel = "securityDefinitions" )
View Source
const ( DefaultLabel = "default" ItemsLabel = "items" )
View Source
const ( PathsLabel = "paths" GetLabel = "get" PostLabel = "post" PatchLabel = "patch" PutLabel = "put" DeleteLabel = "delete" OptionsLabel = "options" HeadLabel = "head" )
View Source
const (
ExamplesLabel = "examples"
)
View Source
const (
HeadersLabel = "headers"
)
View Source
const (
ParametersLabel = "parameters"
)
View Source
const (
ResponsesLabel = "responses"
)
View Source
const (
ScopesLabel = "scopes"
)
View Source
const (
SecurityLabel = "security"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Definitions ¶
type Definitions struct {
Schemas map[low.KeyReference[string]]low.ValueReference[*base.SchemaProxy]
}
func (*Definitions) FindSchema ¶
func (d *Definitions) FindSchema(schema string) *low.ValueReference[*base.SchemaProxy]
type Examples ¶
type Examples struct {
Values map[low.KeyReference[string]]low.ValueReference[any]
}
func (*Examples) FindExample ¶
func (e *Examples) FindExample(name string) *low.ValueReference[any]
type Header ¶
type Header struct {
Type low.NodeReference[string]
Format low.NodeReference[string]
Description low.NodeReference[string]
Items low.NodeReference[*Items]
CollectionFormat low.NodeReference[string]
Default low.NodeReference[any]
Maximum low.NodeReference[int]
ExclusiveMaximum low.NodeReference[bool]
Minimum low.NodeReference[int]
ExclusiveMinimum low.NodeReference[bool]
MaxLength low.NodeReference[int]
MinLength low.NodeReference[int]
Pattern low.NodeReference[string]
MaxItems low.NodeReference[int]
MinItems low.NodeReference[int]
UniqueItems low.NodeReference[bool]
Enum low.NodeReference[[]low.ValueReference[string]]
MultipleOf low.NodeReference[int]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
func (*Header) FindExtension ¶
func (h *Header) FindExtension(ext string) *low.ValueReference[any]
type Items ¶
type Items struct {
Type low.NodeReference[string]
Format low.NodeReference[string]
CollectionFormat low.NodeReference[string]
Items low.NodeReference[*Items]
Default low.NodeReference[any]
Maximum low.NodeReference[int]
ExclusiveMaximum low.NodeReference[bool]
Minimum low.NodeReference[int]
ExclusiveMinimum low.NodeReference[bool]
MaxLength low.NodeReference[int]
MinLength low.NodeReference[int]
Pattern low.NodeReference[string]
MaxItems low.NodeReference[int]
MinItems low.NodeReference[int]
UniqueItems low.NodeReference[bool]
Enum low.NodeReference[[]low.ValueReference[string]]
MultipleOf low.NodeReference[int]
}
type Operation ¶
type Operation struct {
Tags low.NodeReference[[]low.ValueReference[string]]
Summary low.NodeReference[string]
Description low.NodeReference[string]
ExternalDocs low.NodeReference[*base.ExternalDoc]
OperationId low.NodeReference[string]
Consumes low.NodeReference[[]low.ValueReference[string]]
Produces low.NodeReference[[]low.ValueReference[string]]
Parameters low.NodeReference[[]low.ValueReference[*Parameter]]
Responses low.NodeReference[*Responses]
Schemes low.NodeReference[[]low.ValueReference[string]]
Deprecated low.NodeReference[bool]
Security low.NodeReference[[]low.ValueReference[*SecurityRequirement]]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
type Parameter ¶
type Parameter struct {
Name low.NodeReference[string]
In low.NodeReference[string]
Type low.NodeReference[string]
Format low.NodeReference[string]
Description low.NodeReference[string]
Required low.NodeReference[bool]
AllowEmptyValue low.NodeReference[bool]
Schema low.NodeReference[*base.SchemaProxy]
Items low.NodeReference[*Items]
CollectionFormat low.NodeReference[string]
Default low.NodeReference[any]
Maximum low.NodeReference[int]
ExclusiveMaximum low.NodeReference[bool]
Minimum low.NodeReference[int]
ExclusiveMinimum low.NodeReference[bool]
MaxLength low.NodeReference[int]
MinLength low.NodeReference[int]
Pattern low.NodeReference[string]
MaxItems low.NodeReference[int]
MinItems low.NodeReference[int]
UniqueItems low.NodeReference[bool]
Enum low.NodeReference[[]low.ValueReference[string]]
MultipleOf low.NodeReference[int]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
func (*Parameter) FindExtension ¶
func (p *Parameter) FindExtension(ext string) *low.ValueReference[any]
type ParameterDefinitions ¶
type ParameterDefinitions struct {
Definitions map[low.KeyReference[string]]low.ValueReference[*Parameter]
}
func (*ParameterDefinitions) FindParameter ¶
func (pd *ParameterDefinitions) FindParameter(schema string) *low.ValueReference[*Parameter]
type PathItem ¶
type PathItem struct {
Ref low.NodeReference[string]
Get low.NodeReference[*Operation]
Put low.NodeReference[*Operation]
Post low.NodeReference[*Operation]
Delete low.NodeReference[*Operation]
Options low.NodeReference[*Operation]
Head low.NodeReference[*Operation]
Patch low.NodeReference[*Operation]
Parameters low.NodeReference[[]low.ValueReference[*Parameter]]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
func (*PathItem) FindExtension ¶
func (p *PathItem) FindExtension(ext string) *low.ValueReference[any]
type Paths ¶
type Paths struct {
PathItems map[low.KeyReference[string]]low.ValueReference[*PathItem]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
func (*Paths) FindExtension ¶
func (p *Paths) FindExtension(ext string) *low.ValueReference[any]
type Response ¶
type Response struct {
Description low.NodeReference[string]
Schema low.NodeReference[*base.SchemaProxy]
Headers low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Header]]
Examples low.NodeReference[*Examples]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
func (*Response) FindExtension ¶
func (r *Response) FindExtension(ext string) *low.ValueReference[any]
func (*Response) FindHeader ¶
func (r *Response) FindHeader(hType string) *low.ValueReference[*Header]
type Responses ¶
type Responses struct {
Codes map[low.KeyReference[string]]low.ValueReference[*Response]
Default low.NodeReference[*Response]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
func (*Responses) FindResponseByCode ¶
func (r *Responses) FindResponseByCode(code string) *low.ValueReference[*Response]
type ResponsesDefinitions ¶
type ResponsesDefinitions struct {
Definitions map[low.KeyReference[string]]low.ValueReference[*Response]
}
func (*ResponsesDefinitions) FindResponse ¶
func (r *ResponsesDefinitions) FindResponse(schema string) *low.ValueReference[*Response]
type Scopes ¶
type Scopes struct {
Values map[low.KeyReference[string]]low.ValueReference[string]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
type SecurityDefinitions ¶
type SecurityDefinitions struct {
Definitions map[low.KeyReference[string]]low.ValueReference[*SecurityScheme]
}
func (*SecurityDefinitions) FindSecurityDefinition ¶
func (s *SecurityDefinitions) FindSecurityDefinition(schema string) *low.ValueReference[*SecurityScheme]
type SecurityRequirement ¶
type SecurityRequirement struct {
Values low.ValueReference[map[low.KeyReference[string]]low.ValueReference[[]low.ValueReference[string]]]
}
type SecurityScheme ¶
type SecurityScheme struct {
Type low.NodeReference[string]
Description low.NodeReference[string]
Name low.NodeReference[string]
In low.NodeReference[string]
Flow low.NodeReference[string]
AuthorizationUrl low.NodeReference[string]
TokenUrl low.NodeReference[string]
Scopes low.NodeReference[*Scopes]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
}
type Swagger ¶
type Swagger struct {
Swagger low.ValueReference[string]
Info low.NodeReference[*base.Info]
Host low.NodeReference[string]
BasePath low.NodeReference[string]
Schemes low.NodeReference[[]low.ValueReference[string]]
Consumes low.NodeReference[[]low.ValueReference[string]]
Produces low.NodeReference[[]low.ValueReference[string]]
Paths low.NodeReference[*Paths]
Definitions low.NodeReference[*Definitions]
SecurityDefinitions low.NodeReference[*SecurityDefinitions]
Parameters low.NodeReference[*ParameterDefinitions]
Responses low.NodeReference[*ResponsesDefinitions]
Security low.NodeReference[[]low.ValueReference[*SecurityRequirement]]
Tags low.NodeReference[[]low.ValueReference[*base.Tag]]
ExternalDocs low.NodeReference[*base.ExternalDoc]
Extensions map[low.KeyReference[string]]low.ValueReference[any]
Index *index.SpecIndex
SpecInfo *datamodel.SpecInfo
}
func (*Swagger) FindExtension ¶
func (s *Swagger) FindExtension(ext string) *low.ValueReference[any]
Click to show internal directories.
Click to hide internal directories.