Struct ComponentsBuilder

pub struct ComponentsBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> ComponentsBuilder<S>

pub fn build(self) -> Components

where S: IsComplete,

Finish building and return the requested object

pub fn extensions( self, value: impl Into<Extensions>, ) -> ComponentsBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

pub fn maybe_extensions( self, value: Option<impl Into<Extensions>>, ) -> ComponentsBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

impl<S: State> ComponentsBuilder<S>

pub fn schema(self, name: impl Into<String>, schema: impl Into<Schema>) -> Self

Add Schema to Components.

Accepts two arguments where first is name of the schema and second is the schema itself.

pub fn schemas_from_iter<I: IntoIterator<Item = (S2, C)>, C: Into<Schema>, S2: Into<String>>( self, schemas: I, ) -> Self

Add Schemas from iterator.

Examples

Components::builder().schemas_from_iter([(
    "Pet",
    Schema::from(
        Object::builder()
            .property(
                "name",
                Object::builder().schema_type(Type::String),
            )
            .required(["name"])
    ),
)]);

pub fn response<S2: Into<String>, R: Into<RefOr<Response>>>( self, name: S2, response: R, ) -> Self

Add Response to Components.

Method accepts tow arguments; name of the reusable response and response which is the reusable response itself.

pub fn responses_from_iter<I: IntoIterator<Item = (S2, R)>, S2: Into<String>, R: Into<RefOr<Response>>>( self, responses: I, ) -> Self

Add multiple Responses to Components from iterator.

Like the ComponentsBuilder::schemas_from_iter this allows adding multiple responses by any iterator what returns tuples of (name, response) values.

pub fn security_scheme<N: Into<String>, S2: Into<SecurityScheme>>( self, name: N, security_scheme: S2, ) -> Self

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.

Trait Implementations

impl<S: IsComplete> From<ComponentsBuilder<S>> for Components

fn from(value: ComponentsBuilder<S>) -> Self

Converts to this type from the input type.