Struct SecurityScheme

pub struct SecurityScheme {
    pub type: i32,
    pub description: String,
    pub name: String,
    pub in: i32,
    pub flow: i32,
    pub authorization_url: String,
    pub token_url: String,
    pub scopes: Option<Scopes>,
    pub extensions: HashMap<String, Value>,
}

SecurityScheme is a representation of OpenAPI v2 specification’s Security Scheme object.

See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject

Allows the definition of a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2’s common flows (implicit, password, application and access code).

Fields

type: i32

The type of the security scheme. Valid values are “basic”, “apiKey” or “oauth2”.

description: String

A short description for security scheme.

name: String

The name of the header or query parameter to be used. Valid for apiKey.

in: i32

The location of the API key. Valid values are “query” or “header”. Valid for apiKey.

flow: i32

The flow used by the OAuth2 security scheme. Valid values are “implicit”, “password”, “application” or “accessCode”. Valid for oauth2.

authorization_url: String

The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Valid for oauth2/implicit and oauth2/accessCode.

token_url: String

The token URL to be used for this flow. This SHOULD be in the form of a URL. Valid for oauth2/password, oauth2/application and oauth2/accessCode.

scopes: Option<Scopes>

The available scopes for the OAuth2 security scheme. Valid for oauth2.

extensions: HashMap<String, Value>

Custom properties that start with “x-” such as “x-foo” used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

Implementations

impl SecurityScheme

pub fn type(&self) -> Type

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: Type)

Sets type to the provided enum value.

pub fn in(&self) -> In

Returns the enum value of in, or the default if the field is set to an invalid enum value.

pub fn set_in(&mut self, value: In)

Sets in to the provided enum value.

pub fn flow(&self) -> Flow

Returns the enum value of flow, or the default if the field is set to an invalid enum value.

pub fn set_flow(&mut self, value: Flow)

Sets flow to the provided enum value.

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() -> Self

Returns the “default value” for a type.

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 Message for SecurityScheme

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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