Struct openapi_schema::v2::SecurityScheme

pub struct SecurityScheme {
    pub type: SecuritySchemeType,
    pub description: Option<String>,
    pub name: String,
    pub in: InEnum,
    pub flow: Flow,
    pub authorization_url: AuthorizationUrl,
    pub token_url: TokenUrl,
    pub scopes: BTreeMap<String, String>,
    pub extensions: Extensions,
}

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: Flow

The flow used by the OAuth2 security scheme. Valid values are "implicit","password","application" or "accessCode".

authorization_url: AuthorizationUrl

The authorization URL to be used for this flow. This SHOULD be in the form of a URL.

token_url: TokenUrl

The token URL to be used for this flow. This SHOULD be in the form of a URL.

scopes: BTreeMap<String, String>

The available scopes for the OAuth2 security scheme.

extensions: Extensions

Allows extensions to the Swagger Schema.

Trait Implementations

impl Clone for SecurityScheme

fn clone(&self) -> SecurityScheme

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecurityScheme

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecurityScheme

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<SecurityScheme> for SecurityScheme

fn eq(&self, other: &SecurityScheme) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SecurityScheme

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecurityScheme