OpenApiSpex.SecurityScheme (open_api_spex v3.10.0) View Source
Defines the OpenApiSpex.SecurityScheme.t type.
Link to this section Summary
Link to this section Types
Specs
t() :: %OpenApiSpex.SecurityScheme{
bearerFormat: String.t() | nil,
description: String.t() | nil,
flows: OpenApiSpex.OAuthFlows.t() | nil,
in: String.t() | nil,
name: String.t() | nil,
openIdConnectUrl: String.t() | nil,
scheme: String.t() | nil,
type: String.t()
}
Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.