Struct utoipa::openapi::security::OpenIdConnect

#[non_exhaustive]
pub struct OpenIdConnect {
    pub open_id_connect_url: String,
    pub description: Option<String>,
}

Open id connect SecurityScheme

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

open_id_connect_url: String

Url of the OpenIdConnect to discover OAuth2 connect values.

description: Option<String>

Description of OpenIdConnect SecurityScheme supporting markdown syntax.

Implementations

impl OpenIdConnect

pub fn new<S: Into<String>>(open_id_connect_url: S) -> Self

Construct a new open id connect security schema.

Examples

OpenIdConnect::new("https://localhost/openid");

pub fn with_description<S: Into<String>>(
    open_id_connect_url: S,
    description: S
) -> Self

Construct a new OpenIdConnect SecurityScheme with optional description supporting markdown syntax.

Examples

OpenIdConnect::with_description("https://localhost/openid", "my pet api open id connect");

Trait Implementations

impl Clone for OpenIdConnect

fn clone(&self) -> OpenIdConnect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for OpenIdConnect

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

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenIdConnect

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

Serialize this value into the given Serde serializer.