Struct OperationBuilder

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

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

Implementations

impl<S: State> OperationBuilder<S>

pub fn build(self) -> Operation

where S: IsComplete,

Finish building and return the requested object

pub fn summary( self, value: impl Into<String>, ) -> OperationBuilder<SetSummary<S>>

where S::Summary: IsUnset,

Optional (Some / Option setters).

Short summary what Operation does.

pub fn maybe_summary( self, value: Option<impl Into<String>>, ) -> OperationBuilder<SetSummary<S>>

where S::Summary: IsUnset,

Optional (Some / Option setters).

Short summary what Operation does.

pub fn description( self, value: impl Into<String>, ) -> OperationBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters).

Long explanation of Operation behaviour. Markdown syntax is supported.

pub fn maybe_description( self, value: Option<impl Into<String>>, ) -> OperationBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters).

Long explanation of Operation behaviour. Markdown syntax is supported.

pub fn operation_id( self, value: impl Into<String>, ) -> OperationBuilder<SetOperationId<S>>

where S::OperationId: IsUnset,

Optional (Some / Option setters).

Unique identifier for the API Operation. Most typically this is mapped to handler function name.

pub fn maybe_operation_id( self, value: Option<impl Into<String>>, ) -> OperationBuilder<SetOperationId<S>>

where S::OperationId: IsUnset,

Optional (Some / Option setters).

Unique identifier for the API Operation. Most typically this is mapped to handler function name.

pub fn external_docs( self, value: impl Into<ExternalDocs>, ) -> OperationBuilder<SetExternalDocs<S>>

where S::ExternalDocs: IsUnset,

Optional (Some / Option setters).

Additional external documentation for this operation.

pub fn maybe_external_docs( self, value: Option<impl Into<ExternalDocs>>, ) -> OperationBuilder<SetExternalDocs<S>>

where S::ExternalDocs: IsUnset,

Optional (Some / Option setters).

Additional external documentation for this operation.

pub fn request_body( self, value: impl Into<RequestBody>, ) -> OperationBuilder<SetRequestBody<S>>

where S::RequestBody: IsUnset,

Optional (Some / Option setters).

Optional request body for this Operation.

pub fn maybe_request_body( self, value: Option<impl Into<RequestBody>>, ) -> OperationBuilder<SetRequestBody<S>>

where S::RequestBody: IsUnset,

Optional (Some / Option setters).

Optional request body for this Operation.

pub fn callbacks( self, value: impl Into<String>, ) -> OperationBuilder<SetCallbacks<S>>

where S::Callbacks: IsUnset,

Optional (Some / Option setters).

pub fn maybe_callbacks( self, value: Option<impl Into<String>>, ) -> OperationBuilder<SetCallbacks<S>>

where S::Callbacks: IsUnset,

Optional (Some / Option setters).

pub fn deprecated( self, value: impl Into<Deprecated>, ) -> OperationBuilder<SetDeprecated<S>>

where S::Deprecated: IsUnset,

Optional (Some / Option setters).

Define whether the operation is deprecated or not and thus should be avoided consuming.

pub fn maybe_deprecated( self, value: Option<impl Into<Deprecated>>, ) -> OperationBuilder<SetDeprecated<S>>

where S::Deprecated: IsUnset,

Optional (Some / Option setters).

Define whether the operation is deprecated or not and thus should be avoided consuming.

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

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

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

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

impl<S: State> OperationBuilder<S>

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

Append tag to Operation tags.

pub fn tags<T: Into<String>>(self, tags: impl IntoIterator<Item = T>) -> Self

Append tag to Operation tags.

pub fn parameters<P: Into<Parameter>>( self, parameters: impl IntoIterator<Item = P>, ) -> Self

Add or change parameters of the Operation.

pub fn parameter(self, parameter: impl Into<Parameter>) -> Self

Append parameter to Operation parameters.

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

Add or change responses of the Operation.

pub fn response( self, code: impl Into<String>, response: impl Into<RefOr<Response>>, ) -> Self

Append status code and a Response to the Operation responses map.

• code must be valid HTTP status code.
• response is instances of Response.

pub fn security(self, security: impl Into<SecurityRequirement>) -> Self

Append SecurityRequirement to Operation security requirements.

pub fn securities<R: Into<SecurityRequirement>>( self, securities: impl IntoIterator<Item = R>, ) -> Self

Append SecurityRequirement to Operation security requirements.

pub fn servers<E: Into<Server>>( self, servers: impl IntoIterator<Item = E>, ) -> Self

Append Servers to the Operation.

pub fn server(self, server: impl Into<Server>) -> Self

Append a new Server to the Operation servers.

Trait Implementations

impl<S: IsComplete> From<OperationBuilder<S>> for Operation

fn from(builder: OperationBuilder<S>) -> Self

Converts to this type from the input type.