Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Definitions ¶
type Definitions struct {
Definitions map[string]*highbase.SchemaProxy
// contains filtered or unexported fields
}
func NewDefinitions ¶
func NewDefinitions(definitions *low.Definitions) *Definitions
func (*Definitions) GoLow ¶
func (d *Definitions) GoLow() *low.Definitions
type Examples ¶
func NewExamples ¶
type Header ¶
type Header struct {
Type string
Format string
Description string
Items *Items
CollectionFormat string
Default any
Maximum int
ExclusiveMaximum bool
Minimum int
ExclusiveMinimum bool
MaxLength int
MinLength int
Pattern string
MaxItems int
MinItems int
UniqueItems bool
Enum []string
MultipleOf int
Extensions map[string]any
// contains filtered or unexported fields
}
type Items ¶
type Items struct {
Type string
Format string
CollectionFormat string
Items *Items
Default any
Maximum int
ExclusiveMaximum bool
Minimum int
ExclusiveMinimum bool
MaxLength int
MinLength int
Pattern string
MaxItems int
MinItems int
UniqueItems bool
Enum []string
MultipleOf int
// contains filtered or unexported fields
}
type Operation ¶
type Operation struct {
Tags []string
Summary string
Description string
ExternalDocs *base.ExternalDoc
OperationId string
Consumes []string
Produces []string
Parameters []*Parameter
Responses *Responses
Schemes []string
Deprecated bool
Security []*SecurityRequirement
Extensions map[string]any
// contains filtered or unexported fields
}
func NewOperation ¶
type Parameter ¶
type Parameter struct {
Name string
In string
Type string
Format string
Description string
Required bool
AllowEmptyValue bool
Schema *base.SchemaProxy
Items *Items
CollectionFormat string
Default any
Maximum int
ExclusiveMaximum bool
Minimum int
ExclusiveMinimum bool
MaxLength int
MinLength int
Pattern string
MaxItems int
MinItems int
UniqueItems bool
Enum []string
MultipleOf int
Extensions map[string]any
// contains filtered or unexported fields
}
func NewParameter ¶
type ParameterDefinitions ¶
type ParameterDefinitions struct {
Definitions map[string]*Parameter
// contains filtered or unexported fields
}
func NewParametersDefinitions ¶
func NewParametersDefinitions(parametersDefinitions *low.ParameterDefinitions) *ParameterDefinitions
func (*ParameterDefinitions) GoLow ¶
func (p *ParameterDefinitions) GoLow() *low.ParameterDefinitions
type PathItem ¶
type PathItem struct {
Ref string
Get *Operation
Put *Operation
Post *Operation
Delete *Operation
Options *Operation
Head *Operation
Patch *Operation
Parameters []*Parameter
Extensions map[string]any
// contains filtered or unexported fields
}
func NewPathItem ¶
type Paths ¶
type Response ¶
type Response struct {
Description string
Schema *base.SchemaProxy
Headers map[string]*Header
Examples *Examples
Extensions map[string]any
// contains filtered or unexported fields
}
func NewResponse ¶
type Responses ¶
type Responses struct {
Codes map[string]*Response
Default *Response
Extensions map[string]any
// contains filtered or unexported fields
}
func NewResponses ¶
type ResponsesDefinitions ¶
type ResponsesDefinitions struct {
Definitions map[string]*Response
// contains filtered or unexported fields
}
func NewResponsesDefinitions ¶
func NewResponsesDefinitions(responsesDefinitions *low.ResponsesDefinitions) *ResponsesDefinitions
func (*ResponsesDefinitions) GoLow ¶
func (r *ResponsesDefinitions) GoLow() *low.ResponsesDefinitions
type SecurityDefinitions ¶
type SecurityDefinitions struct {
Definitions map[string]*SecurityScheme
// contains filtered or unexported fields
}
func NewSecurityDefinitions ¶
func NewSecurityDefinitions(definitions *low.SecurityDefinitions) *SecurityDefinitions
func (*SecurityDefinitions) GoLow ¶
func (sd *SecurityDefinitions) GoLow() *low.SecurityDefinitions
type SecurityRequirement ¶
type SecurityRequirement struct {
Requirements map[string][]string
// contains filtered or unexported fields
}
func NewSecurityRequirement ¶
func NewSecurityRequirement(req *low.SecurityRequirement) *SecurityRequirement
func (*SecurityRequirement) GoLow ¶
func (s *SecurityRequirement) GoLow() *low.SecurityRequirement
type SecurityScheme ¶
type SecurityScheme struct {
Type string
Description string
Name string
In string
Flow string
AuthorizationUrl string
TokenUrl string
Scopes *Scopes
Extensions map[string]any
// contains filtered or unexported fields
}
func NewSecurityScheme ¶
func NewSecurityScheme(securityScheme *low.SecurityScheme) *SecurityScheme
func (*SecurityScheme) GoLow ¶
func (s *SecurityScheme) GoLow() *low.SecurityScheme
type Swagger ¶
type Swagger struct {
Swagger string
Info *base.Info
Host string
BasePath string
Schemes []string
Consumes []string
Produces []string
Paths *Paths
Definitions *Definitions
Parameters *ParameterDefinitions
Responses *ResponsesDefinitions
SecurityDefinitions *SecurityDefinitions
Security []*SecurityRequirement
Tags []*base.Tag
ExternalDocs *base.ExternalDoc
Extensions map[string]any
// contains filtered or unexported fields
}
func NewSwaggerDocument ¶
Click to show internal directories.
Click to hide internal directories.