Struct SecurityScheme

pub struct SecurityScheme {
    pub _type: SecurityType,
    pub description: Option<String>,
    pub extensions: IndexMap<String, Value>,
}

Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2’s common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.

Fields

_type: SecurityType

The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".

description: Option<String>

A short description for security scheme. CommonMark syntax MAY be used for rich text representation.

extensions: IndexMap<String, Value>

This object MAY be extended with Specification Extensions.

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 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.