Struct SecurityScheme

pub struct SecurityScheme {

    pub scheme_type: SecuritySchemeType,
    pub description: Option<String>,
    pub name: String,
    pub location: String,
    pub x_fields: HashMap<String, Value>,
    pub flow: Option<String>,
    pub authorization_url: Option<String>,
    pub token_url: Option<String>,
    pub scopes: HashMap<String, String>,
    pub scheme: Option<String>,
    pub bearer_format: Option<String>,
    pub flows: Option<OAuthFlows>,
    pub open_id_connect_url: Option<String>,
}

Security Scheme Object

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

scheme_type: SecuritySchemeType

description: Option<String>

name: String

location: String

x_fields: HashMap<String, Value>

Allows extensions to the Swagger Schema. The field name MUST begin with x-, for example, x-internal-id. The value can be null, a primitive, an array or an object. See Vendor Extensions for further details.

flow: Option<String>

authorization_url: Option<String>

token_url: Option<String>

scopes: HashMap<String, String>

scheme: Option<String>

bearer_format: Option<String>

flows: Option<OAuthFlows>

open_id_connect_url: Option<String>

Trait Implementations

impl Clone for SecurityScheme

fn clone(&self) -> SecurityScheme

Returns a duplicate 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 Default for SecurityScheme

fn default() -> SecurityScheme

Returns the “default value” for a type.

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

where SecurityScheme: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SecurityScheme

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Resolvable for SecurityScheme

fn resolve(spec: &Spec, path: &String) -> Result<Self, ResolveError>

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