Struct Operation

#[non_exhaustive]
pub struct Operation {

    pub tags: Option<Vec<String>>,
    pub parameters: Option<Vec<Parameter>>,
    pub responses: Responses,
    pub servers: Option<Vec<Server>>,
    pub security: Option<Vec<SecurityRequirement>>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub operation_id: Option<String>,
    pub external_docs: Option<ExternalDocs>,
    pub request_body: Option<RequestBody>,
    pub callbacks: Option<String>,
    pub deprecated: Option<Deprecated>,
    pub extensions: Option<Extensions>,
}

Implements OpenAPI Operation Object object.

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.

tags: Option<Vec<String>>

List of tags used for grouping operations.

parameters: Option<Vec<Parameter>>

List of applicable parameters for this Operation.

responses: Responses

List of possible responses returned by the Operation.

servers: Option<Vec<Server>>

Alternative Servers for this Operation.

security: Option<Vec<SecurityRequirement>>

Declaration which security mechanisms can be used for for the operation. Only one SecurityRequirement must be met.

Security for the Operation can be set to optional by adding empty security with SecurityRequirement::default.

summary: Option<String>

Short summary what Operation does.

description: Option<String>

Long explanation of Operation behaviour. Markdown syntax is supported.

operation_id: Option<String>

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

external_docs: Option<ExternalDocs>

Additional external documentation for this operation.

request_body: Option<RequestBody>

Optional request body for this Operation.

callbacks: Option<String>

deprecated: Option<Deprecated>

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

extensions: Option<Extensions>

Optional extensions “x-something”.

Implementations

impl Operation

pub fn builder() -> OperationBuilder

Create an instance of Operation using the builder syntax

impl Operation

pub fn new() -> Self

Construct a new API Operation.

impl Operation

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

Append tag to Operation tags.

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

Append tag to Operation tags.

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

Add or change parameters of the Operation.

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

Append parameter to Operation parameters.

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

Add or change responses of the Operation.

pub fn response( &mut self, code: impl Into<String>, response: impl Into<RefOr<Response>>, ) -> &mut 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( &mut self, security: impl Into<SecurityRequirement>, ) -> &mut Self

Append SecurityRequirement to Operation security requirements.

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

Append SecurityRequirement to Operation security requirements.

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

Append Servers to the Operation.

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

Append a new Server to the Operation servers.

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Operation

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

Formats the value using the given formatter.

impl Default for Operation

fn default() -> Operation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Operation

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<OperationBuilder<S>> for Operation

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

Converts to this type from the input type.

impl PartialEq for Operation

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

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 Operation