Enum SecurityScheme 

pub enum SecurityScheme {
    Bearer {
        format: Option<String>,
        description: Option<String>,
    },
    Basic {
        description: Option<String>,
    },
    ApiKey {
        name: String,
        location: ApiKeyLocation,
        description: Option<String>,
    },
    OAuth2 {
        flows: Box<OAuth2Flows>,
        description: Option<String>,
    },
    OpenIdConnect {
        open_id_connect_url: String,
        description: Option<String>,
    },
}

OpenAPI security scheme configuration.

This enum represents the different types of security schemes supported by OpenAPI. Each variant maps directly to an OpenAPI security scheme type.

Supported Schemes

• Bearer: HTTP Bearer token authentication (RFC 6750)
• Basic: HTTP Basic authentication (RFC 7617)
• ApiKey: API key passed in header, query, or cookie
• OAuth2: OAuth 2.0 authentication flows
• OpenIdConnect: OpenID Connect Discovery

Example

use clawspec_core::{SecurityScheme, ApiKeyLocation};

// Simple bearer token
let bearer = SecurityScheme::bearer();

// Bearer with JWT format hint
let jwt = SecurityScheme::bearer_with_format("JWT");

// API key in header
let api_key = SecurityScheme::api_key("X-API-Key", ApiKeyLocation::Header);

// Basic auth
let basic = SecurityScheme::basic();

Variants

Bearer

HTTP Bearer authentication (RFC 6750).

Used for token-based authentication where the client sends an Authorization: Bearer <token> header.

Fields

format: Option<String>

Optional format hint (e.g., “JWT” for JSON Web Tokens)

description: Option<String>

Description for documentation

Basic

HTTP Basic authentication (RFC 7617).

Uses Authorization: Basic <base64(username:password)> header.

Fields

description: Option<String>

Description for documentation

ApiKey

API Key authentication.

The API key can be passed in a header, query parameter, or cookie.

Fields

name: String

Name of the header, query parameter, or cookie

location: ApiKeyLocation

Where the API key is passed

description: Option<String>

Description for documentation

OAuth2

OAuth 2.0 authentication.

Supports multiple OAuth2 flows: authorization code, client credentials, implicit, and password.

Fields

flows: Box<OAuth2Flows>

OAuth2 flows configuration (boxed to reduce enum size)

description: Option<String>

Description for documentation

OpenIdConnect

OpenID Connect Discovery.

Uses OpenID Connect for authentication with automatic discovery of the provider’s configuration.

Fields

open_id_connect_url: String

OpenID Connect discovery URL

description: Option<String>

Description for documentation

Implementations

impl SecurityScheme

pub fn bearer() -> Self

Creates a simple HTTP Bearer authentication scheme.

Example

use clawspec_core::SecurityScheme;

let scheme = SecurityScheme::bearer();

pub fn bearer_with_format(format: impl Into<String>) -> Self

Creates an HTTP Bearer authentication scheme with a format hint.

Arguments

• format - Format hint (e.g., “JWT” for JSON Web Tokens)

Example

use clawspec_core::SecurityScheme;

let scheme = SecurityScheme::bearer_with_format("JWT");

pub fn basic() -> Self

Creates an HTTP Basic authentication scheme.

Example

use clawspec_core::SecurityScheme;

let scheme = SecurityScheme::basic();

pub fn api_key(name: impl Into<String>, location: ApiKeyLocation) -> Self

Creates an API Key authentication scheme.

Arguments

• name - Name of the header, query parameter, or cookie
• location - Where the API key is passed

Example

use clawspec_core::{SecurityScheme, ApiKeyLocation};

let scheme = SecurityScheme::api_key("X-API-Key", ApiKeyLocation::Header);

pub fn openid_connect(url: impl Into<String>) -> Self

Creates an OpenID Connect authentication scheme.

Arguments

• url - OpenID Connect discovery URL

Example

use clawspec_core::SecurityScheme;

let scheme = SecurityScheme::openid_connect("https://auth.example.com/.well-known/openid-configuration");

pub fn with_description(self, description: impl Into<String>) -> Self

Adds a description to the security scheme.

Example

use clawspec_core::SecurityScheme;

let scheme = SecurityScheme::bearer()
    .with_description("JWT token obtained from /auth/login");

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