Struct Components

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

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: IndexMap<String, Schema>

Map of reusable OpenAPI Schema Objects.

responses: IndexMap<String, RefOr<Response>>

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

security_schemes: IndexMap<String, SecurityScheme>

Map of reusable OpenAPI Security Scheme Objects.

extensions: Option<Extensions>

Optional extensions “x-something”.

Implementations

impl Components

pub fn builder() -> ComponentsBuilder

Create an instance of Components using the builder syntax

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_scheme: 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<N: Into<String>, S: Into<SecurityScheme>>( &mut self, schemas: impl IntoIterator<Item = (N, S)>, )

Add iterator of SecuritySchemes to Components.

Accepts two arguments where first is the name of the SecurityScheme. This is later when referenced by [SecurityRequirement.requirement]s. Second parameter is the SecurityScheme.

pub fn add_schema<N: Into<String>, S: Into<Schema>>( &mut self, name: N, scheme: S, )

Add Schema to Components.

Accepts two arguments where first is the name of the Schema. This is later when referenced by [Ref.ref_location]s. Second parameter is the Schema.

pub fn add_schemas_from_iter<N: Into<String>, S: Into<Schema>>( &mut self, schemas: impl IntoIterator<Item = (N, S)>, )

Add iterator of Schemas to Components.

Accepts two arguments where first is the name of the Schema. This is later when referenced by [Ref.ref_location]s. Second parameter is the Schema.

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 Debug for Components

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

Formats the value using the given formatter.

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<S: IsComplete> From<ComponentsBuilder<S>> for Components

fn from(value: ComponentsBuilder<S>) -> 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