Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ExampleSource ¶
type ExampleSource string
const ( ExampleFromExplicit ExampleSource = "explicit" ExampleFromDefault ExampleSource = "default" ExampleFromEnum ExampleSource = "enum" ExampleFromSchema ExampleSource = "schema" )
type HTTPMethod ¶
type HTTPMethod string
const ( MethodGet HTTPMethod = "GET" MethodPost HTTPMethod = "POST" MethodPut HTTPMethod = "PUT" MethodPatch HTTPMethod = "PATCH" MethodDelete HTTPMethod = "DELETE" MethodHead HTTPMethod = "HEAD" MethodOptions HTTPMethod = "OPTIONS" MethodTrace HTTPMethod = "TRACE" )
type OAuthFlow ¶
type OAuthFlow struct {
Type OAuthFlowType
AuthorizationURL string
TokenURL string
RefreshURL string
Scopes []string
}
type OAuthFlowType ¶
type OAuthFlowType string
const ( OAuthFlowAuthorizationCode OAuthFlowType = "authorizationCode" OAuthFlowImplicit OAuthFlowType = "implicit" OAuthFlowPassword OAuthFlowType = "password" OAuthFlowClientCredentials OAuthFlowType = "clientCredentials" )
type Operation ¶
type Operation struct {
ID string
Method HTTPMethod
Path string
Summary string
Description string
Tags []string
Deprecated bool
Servers []Server
Parameters []Parameter
RequestBody *RequestBody
Responses []Response
Security []SecurityRequirement
}
type ParameterLocation ¶
type ParameterLocation string
const ( InPath ParameterLocation = "path" InQuery ParameterLocation = "query" InHeader ParameterLocation = "header" InCookie ParameterLocation = "cookie" )
type RequestBody ¶
type SecurityRequirement ¶
type SecurityScheme ¶
type SecurityScheme struct {
Type SecuritySchemeType
Subtype string
Name string
In ParameterLocation
Description string
BearerFormat string
OAuthFlows []OAuthFlow
}
type SecuritySchemeType ¶
type SecuritySchemeType string
const ( SecurityHTTP SecuritySchemeType = "http" SecurityAPIKey SecuritySchemeType = "apiKey" SecurityOAuth2 SecuritySchemeType = "oauth2" SecurityOpenID SecuritySchemeType = "openIdConnect" )
Click to show internal directories.
Click to hide internal directories.