Struct SecurityScheme

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

§authorization_url: Option<AuthorizationUrl>

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

Source§

fn clone(&self) -> SecurityScheme

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SecurityScheme

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SecurityScheme

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for SecurityScheme

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SecurityScheme

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,