Documentation
¶
Index ¶
- func ExtractContent(...) map[string]*MediaType
- func ExtractEncoding(...) map[string]*Encoding
- func ExtractExamples(...) map[string]*Example
- func ExtractHeaders(...) map[string]*Header
- type Callback
- type Components
- type Contact
- type Discriminator
- type Document
- type Encoding
- type Example
- type ExternalDoc
- type Header
- type Info
- type License
- type Link
- type MediaType
- type OAuthFlow
- type OAuthFlows
- type Operation
- type Parameter
- type PathItem
- type Paths
- type RequestBody
- type Response
- type Responses
- type Schema
- type SchemaProxy
- type SecurityRequirement
- type SecurityScheme
- type Server
- type ServerVariable
- type Tag
- type XML
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExtractContent ¶
func ExtractContent(elements map[lowmodel.KeyReference[string]]lowmodel.ValueReference[*low.MediaType]) map[string]*MediaType
func ExtractEncoding ¶
func ExtractEncoding(elements map[lowmodel.KeyReference[string]]lowmodel.ValueReference[*low.Encoding]) map[string]*Encoding
func ExtractExamples ¶
func ExtractExamples(elements map[lowmodel.KeyReference[string]]lowmodel.ValueReference[*low.Example]) map[string]*Example
func ExtractHeaders ¶
func ExtractHeaders(elements map[lowmodel.KeyReference[string]]lowmodel.ValueReference[*low.Header]) map[string]*Header
Types ¶
type Callback ¶
type Callback struct {
Expression map[string]*PathItem
Extensions map[string]any
// contains filtered or unexported fields
}
func NewCallback ¶
type Components ¶
type Components struct {
Schemas map[string]*SchemaProxy
Responses map[string]*Response
Parameters map[string]*Parameter
Examples map[string]*Example
RequestBodies map[string]*RequestBody
Headers map[string]*Header
SecuritySchemes map[string]*SecurityScheme
Links map[string]*Link
Callbacks map[string]*Callback
Extensions map[string]any
// contains filtered or unexported fields
}
func NewComponents ¶
func NewComponents(comp *low.Components) *Components
func (*Components) GoLow ¶
func (c *Components) GoLow() *low.Components
type Contact ¶
type Contact struct {
Name string
URL string
Email string
// contains filtered or unexported fields
}
func NewContact ¶
type Discriminator ¶
type Discriminator struct {
PropertyName string
Mapping map[string]string
// contains filtered or unexported fields
}
func NewDiscriminator ¶
func NewDiscriminator(disc *low.Discriminator) *Discriminator
func (*Discriminator) GoLow ¶
func (d *Discriminator) GoLow() *low.Discriminator
type Document ¶
type Document struct {
Version string
Info *Info
Servers []*Server
Paths *Paths
Components *Components
Security *SecurityRequirement
Tags []*Tag
ExternalDocs *ExternalDoc
Extensions map[string]any
Index *index.SpecIndex
// contains filtered or unexported fields
}
func NewDocument ¶
type Encoding ¶
type Encoding struct {
ContentType string
Headers map[string]*Header
Style string
Explode bool
AllowReserved bool
// contains filtered or unexported fields
}
func NewEncoding ¶
type Example ¶
type Example struct {
Summary string
Description string
Value any
ExternalValue string
Extensions map[string]any
// contains filtered or unexported fields
}
func NewExample ¶
type ExternalDoc ¶
type ExternalDoc struct {
Description string
URL string
Extensions map[string]any
// contains filtered or unexported fields
}
func NewExternalDoc ¶
func NewExternalDoc(extDoc *low.ExternalDoc) *ExternalDoc
func (*ExternalDoc) GoLow ¶
func (e *ExternalDoc) GoLow() *low.ExternalDoc
type Header ¶
type Info ¶
type License ¶
func NewLicense ¶
type Link ¶
type MediaType ¶
type MediaType struct {
Schema *SchemaProxy
Example any
Examples map[string]*Example
Encoding map[string]*Encoding
Extensions map[string]any
// contains filtered or unexported fields
}
func NewMediaType ¶
type OAuthFlow ¶
type OAuthFlow struct {
AuthorizationUrl string
TokenUrl string
RefreshUrl string
Scopes map[string]string
Extensions map[string]any
// contains filtered or unexported fields
}
func NewOAuthFlow ¶
type OAuthFlows ¶
type OAuthFlows struct {
Implicit *OAuthFlow
Password *OAuthFlow
ClientCredentials *OAuthFlow
AuthorizationCode *OAuthFlow
Extensions map[string]any
// contains filtered or unexported fields
}
func NewOAuthFlows ¶
func NewOAuthFlows(flows *low.OAuthFlows) *OAuthFlows
func (*OAuthFlows) GoLow ¶
func (o *OAuthFlows) GoLow() *low.OAuthFlows
type Operation ¶
type Operation struct {
Tags []string
Summary string
Description string
ExternalDocs *ExternalDoc
OperationId string
Parameters []*Parameter
RequestBody *RequestBody
Responses *Responses
Callbacks map[string]*Callback
Deprecated bool
Security *SecurityRequirement
Servers []*Server
Extensions map[string]any
// contains filtered or unexported fields
}
func NewOperation ¶
type Parameter ¶
type Parameter struct {
Name string
In string
Description string
Required bool
Deprecated bool
AllowEmptyValue bool
Style string
Explode bool
AllowReserved bool
Schema *SchemaProxy
Example any
Examples map[string]*Example
Content map[string]*MediaType
Extensions map[string]any
// contains filtered or unexported fields
}
func NewParameter ¶
type PathItem ¶
type PathItem struct {
Description string
Summary string
Get *Operation
Put *Operation
Post *Operation
Delete *Operation
Options *Operation
Head *Operation
Patch *Operation
Trace *Operation
Servers []*Server
Parameters []*Parameter
Extensions map[string]any
// contains filtered or unexported fields
}
func NewPathItem ¶
type Paths ¶
type RequestBody ¶
type RequestBody struct {
Description string
Content map[string]*MediaType
Required bool
Extensions map[string]any
// contains filtered or unexported fields
}
func NewRequestBody ¶
func NewRequestBody(rb *low.RequestBody) *RequestBody
func (*RequestBody) GoLow ¶
func (r *RequestBody) GoLow() *low.RequestBody
type Response ¶
type Response struct {
Description string
Headers map[string]*Header
Content map[string]*MediaType
Extensions map[string]any
Links map[string]*Link
// contains filtered or unexported fields
}
func NewResponse ¶
type Responses ¶
type Responses struct {
Codes map[string]*Response
Default *Response
// contains filtered or unexported fields
}
func NewResponses ¶
func (*Responses) FindResponseByCode ¶
type Schema ¶
type Schema struct {
Title string
MultipleOf int
Maximum int
ExclusiveMaximum int
Minimum int
ExclusiveMinimum int
MaxLength int
MinLength int
Pattern string
Format string
MaxItems int
MinItems int
UniqueItems int
MaxProperties int
MinProperties int
Required []string
Enum []string
Type string
AllOf []*SchemaProxy
OneOf []*SchemaProxy
AnyOf []*SchemaProxy
Not []*SchemaProxy
Items []*SchemaProxy
Properties map[string]*SchemaProxy
AdditionalProperties any
Description string
Default any
Nullable bool
Discriminator *Discriminator
ReadOnly bool
WriteOnly bool
XML *XML
ExternalDocs *ExternalDoc
Example any
Deprecated bool
Extensions map[string]any
// contains filtered or unexported fields
}
type SchemaProxy ¶
type SchemaProxy struct {
// contains filtered or unexported fields
}
func (*SchemaProxy) GetBuildError ¶
func (sp *SchemaProxy) GetBuildError() error
func (*SchemaProxy) Schema ¶
func (sp *SchemaProxy) Schema() *Schema
type SecurityRequirement ¶
type SecurityRequirement struct {
ValueRequirements []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
Scheme string
BearerFormat string
Flows *OAuthFlows
OpenIdConnectUrl string
Extensions map[string]any
// contains filtered or unexported fields
}
func NewSecurityScheme ¶
func NewSecurityScheme(ss *low.SecurityScheme) *SecurityScheme
func (*SecurityScheme) GoLow ¶
func (s *SecurityScheme) GoLow() *low.SecurityScheme
type Server ¶
type Server struct {
URL string
Description string
Variables map[string]*ServerVariable
// contains filtered or unexported fields
}
type ServerVariable ¶
type ServerVariable struct {
Enum []string
Default string
Description string
// contains filtered or unexported fields
}
func NewServerVariable ¶
func NewServerVariable(variable *low.ServerVariable) *ServerVariable
func (*ServerVariable) GoLow ¶
func (s *ServerVariable) GoLow() *low.ServerVariable
Source Files
¶
- callback.go
- components.go
- contact.go
- discriminator.go
- document.go
- encoding.go
- example.go
- external_doc.go
- header.go
- info.go
- license.go
- link.go
- media_type.go
- oauth_flow.go
- oauth_flows.go
- operation.go
- parameter.go
- path_item.go
- paths.go
- request_body.go
- response.go
- responses.go
- schema.go
- schema_proxy.go
- security_requirement.go
- security_scheme.go
- server.go
- server_variable.go
- tag.go
- xml.go
Click to show internal directories.
Click to hide internal directories.