Struct utoipa::openapi::schema::Components

#[non_exhaustive]
pub struct Components {
    pub schemas: BTreeMap<String, RefOr<Schema>>,
    pub responses: BTreeMap<String, RefOr<Response>>,
    pub security_schemes: BTreeMap<String, SecurityScheme>,
}

Implements OpenAPI Components Object which holds supported reusable objects.

Components can hold either reusable types themselves or references to other reusable types.

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.

schemas: BTreeMap<String, RefOr<Schema>>

Map of reusable OpenAPI Schema Objects.

responses: BTreeMap<String, RefOr<Response>>

Map of reusable response name, to OpenAPI Response Objects or OpenAPI References to OpenAPI Response Objects.

security_schemes: BTreeMap<String, SecurityScheme>

Map of reusable OpenAPI Security Scheme Objects.

Implementations

impl Components

pub fn new() -> Self

Construct a new Components.

pub fn add_security_scheme<N: Into<String>, S: Into<SecurityScheme>>( &mut self, name: N, security_schema: S, )

Add SecurityScheme to Components

Accepts two arguments where first is the name of the SecurityScheme. This is later when referenced by SecurityRequirements. Second parameter is the SecurityScheme.

pub fn add_security_schemes_from_iter<I: IntoIterator<Item = (N, S)>, N: Into<String>, S: Into<SecurityScheme>>( &mut self, schemas: I, )

Add iterator of SecuritySchemes to Components.

Accepts two arguments where first is the name of the SecurityScheme. This is later when referenced by SecurityRequirements. Second parameter is the SecurityScheme.

Trait Implementations

impl Clone for Components

fn clone(&self) -> Components

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Components

fn default() -> Components

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Components

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Components> for ComponentsBuilder

fn from(value: Components) -> Self

Converts to this type from the input type.

impl From<ComponentsBuilder> for Components

fn from(value: ComponentsBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for Components

fn eq(&self, other: &Components) -> 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 Serialize for Components

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Components