Documentation
¶
Index ¶
- Constants
- func New(store *store.Store, name string, opts ...Option) *v3.SecurityScheme
- type OAuthFlowOption
- type OAuthFlowsOption
- func FlowAuthorizationCode(authorizationUrl, tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
- func FlowClientCredentials(tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
- func FlowDevice(tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
- func FlowImplicit(authorizationUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
- func FlowPassword(tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
- type Option
- func ApiKey(in, name string) Option
- func BearerFormat(s string) Option
- func Deprecated() Option
- func Description(s string) Option
- func Flows(opts ...OAuthFlowsOption) Option
- func HTTP(scheme string) Option
- func In(s string) Option
- func Name(s string) Option
- func OAuth2MetadataUrl(url string) Option
- func OpenIdConnectUrl(url string) Option
- func Reference(name string) Option
- func Scheme(s string) Option
- func Type(s string) Option
Constants ¶
const ( // TypeApiKey identifies an apiKey security scheme. TypeApiKey = "apiKey" // TypeHTTP identifies an http security scheme. TypeHTTP = "http" // TypeOAuth2 identifies an oauth2 security scheme. TypeOAuth2 = "oauth2" // TypeOpenIdConnect identifies an openIdConnect security scheme. TypeOpenIdConnect = "openIdConnect" // InHeader identifies a header API key location. InHeader = "header" // InQuery identifies a query API key location. InQuery = "query" // InCookie identifies a cookie API key location. InCookie = "cookie" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type OAuthFlowOption ¶
OAuthFlowOption configures a single OAuth2 flow.
func FlowRefreshUrl ¶
func FlowRefreshUrl(url string) OAuthFlowOption
FlowRefreshUrl sets the refresh URL for the OAuth2 flow.
func FlowScope ¶
func FlowScope(name, description string) OAuthFlowOption
FlowScope adds a scope to the OAuth2 flow.
type OAuthFlowsOption ¶
type OAuthFlowsOption func(*v3.OAuthFlows)
OAuthFlowsOption configures the OAuth2 flows object.
func FlowAuthorizationCode ¶
func FlowAuthorizationCode(authorizationUrl, tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
FlowAuthorizationCode configures the OAuth2 authorization code flow.
func FlowClientCredentials ¶
func FlowClientCredentials(tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
FlowClientCredentials configures the OAuth2 client credentials flow.
func FlowDevice ¶
func FlowDevice(tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
FlowDevice configures the OAuth2 device authorization flow (OpenAPI 3.2+).
func FlowImplicit ¶
func FlowImplicit(authorizationUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
FlowImplicit configures the OAuth2 implicit flow.
func FlowPassword ¶
func FlowPassword(tokenUrl string, opts ...OAuthFlowOption) OAuthFlowsOption
FlowPassword configures the OAuth2 resource owner password flow.
type Option ¶
type Option func(*v3.SecurityScheme)
Option configures an OpenAPI security scheme.
func ApiKey ¶
ApiKey sets an "apiKey" security scheme type. in must be "header", "query", or "cookie".
func BearerFormat ¶
BearerFormat sets a hint for the bearer token format, e.g. "JWT".
func Deprecated ¶
func Deprecated() Option
Deprecated marks the security scheme as deprecated (OpenAPI 3.2+).
func Description ¶
Description sets the security scheme description.
func Flows ¶
func Flows(opts ...OAuthFlowsOption) Option
Flows sets the OAuth2 flows for the security scheme.
func HTTP ¶
HTTP sets an "http" security scheme type. scheme is the HTTP Authorization scheme name (e.g. "bearer", "basic").
func OAuth2MetadataUrl ¶
OAuth2MetadataUrl sets the OAuth2 metadata URL (OpenAPI 3.2+).
func OpenIdConnectUrl ¶
OpenIdConnectUrl sets the OpenID Connect discovery URL.
Source Files