pub struct SecurityScheme {
pub type: SecuritySchemeType,
pub description: Option<String>,
pub name: String,
pub in: InEnum,
pub flow: Option<Flow>,
pub authorization_url: Option<AuthorizationUrl>,
pub token_url: Option<TokenUrl>,
pub scopes: Option<BTreeMap<String, String>>,
pub extensions: Extensions,
}
Expand description
§SecurityScheme
A declaration of the security schemes available to be used in the specification.
This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme.
Fields§
§type: SecuritySchemeType
The type of the security scheme. Valid values are "basic"
, "apiKey"
or "oauth2"
.
description: Option<String>
A short description for security scheme.
name: String
The name of the header or query parameter to be used.
in: InEnum
The location of the API key. Valid values are "query"
or "header"
.
flow: Option<Flow>
The flow used by the OAuth2 security scheme. Valid values are "implicit"
,"password"
,"application"
or "accessCode"
.
The authorization URL to be used for this flow. This SHOULD be in the form of a URL.
token_url: Option<TokenUrl>
The token URL to be used for this flow. This SHOULD be in the form of a URL.
scopes: Option<BTreeMap<String, String>>
The available scopes for the OAuth2 security scheme.
extensions: Extensions
Allows extensions to the Swagger Schema.
Trait Implementations§
Source§impl Clone for SecurityScheme
impl Clone for SecurityScheme
Source§fn clone(&self) -> SecurityScheme
fn clone(&self) -> SecurityScheme
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more