Struct OpenApiMetadata 

pub struct OpenApiMetadata { /* private fields */ }

Baukit document metadata and optional security conventions.

New metadata uses / as its server, allowing the same schema to describe the service at any deployment origin. Use OpenApiMetadata::servers when a product has explicit server URLs. Applying metadata preserves product-owned paths, schemas, contact information, license, and existing security schemes. Call OpenApiMetadata::bearer_auth to add Baukit’s standard bearer JWT component; unauthenticated APIs omit it by default.

Implementations

impl OpenApiMetadata

pub fn new<T, V, D>(title: T, version: V, description: D) -> Self

where T: Into<String>, V: Into<String>, D: Into<String>,

Creates metadata from a service’s display title, version, and safe public description.

pub fn servers<I>(self, servers: I) -> Self

where I: IntoIterator<Item = Server>,

Replaces the default relative server with the supplied server entries.

Passing an empty iterator omits the explicit server list and restores OpenAPI’s implicit / server behavior.

pub const fn bearer_auth(self) -> Self

Adds Baukit’s standard HTTP bearer JWT security-scheme component.

This only registers the reusable component named BEARER_AUTH_SCHEME; products still decide which operations or documents require it.

pub fn apply_to(&self, openapi: &mut OpenApi)

Applies metadata, the server list, and any opted-in conventions to a document.

Trait Implementations

impl Clone for OpenApiMetadata

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.