Struct APIKeySecurityScheme 

pub struct APIKeySecurityScheme {
    pub name: String,
    pub location: String,
    pub description: Option<String>,
}

An API key-based security scheme.

Fields

name: String

The name of the header, query, or cookie parameter to be used.

location: String

The location of the API key.

description: Option<String>

A description of the security scheme.

Trait Implementations

impl Clone for APIKeySecurityScheme

fn clone(&self) -> APIKeySecurityScheme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for APIKeySecurityScheme

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for APIKeySecurityScheme

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for APIKeySecurityScheme

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for APIKeySecurityScheme

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

where __S: Serializer,

Serialize this value into the given Serde serializer.