Struct AuthData

pub struct AuthData {
    pub api_key: SecretString,
}

Struct that encapsulates valid authentication methods.

Description

Restricted endpoints of the API require the client to include one of the following methods to authenticate:

• API key: a token that is shared with clients to allow M2M connections to the API.

Fields

api_key: SecretString

For token-based authentication methods.

Trait Implementations

impl Debug for AuthData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for AuthData

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of [openapi::path::Parameter]s to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.

impl<'__s> ToSchema<'__s> for AuthData

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the [ToSchema::schema].