Struct utoipa::openapi::path::Operation

source ·
#[non_exhaustive]
pub struct Operation { pub tags: Option<Vec<String>>, pub summary: Option<String>, pub description: Option<String>, pub operation_id: Option<String>, pub external_docs: Option<ExternalDocs>, pub parameters: Option<Vec<Parameter>>, pub request_body: Option<RequestBody>, pub responses: Responses, pub callbacks: Option<String>, pub deprecated: Option<Deprecated>, pub security: Option<Vec<SecurityRequirement>>, pub servers: Option<Vec<Server>>, }
Expand description

Implements OpenAPI Operation Object object.

Fields (Non-exhaustive)§

This struct is marked as 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.

When used with derive #[utoipa::path(...)] attribute macro the default value used will be resolved from handler path provided in #[openapi(paths(...))] with #[derive(OpenApi)] macro. If path resolves to None value crate will be used by default.

§summary: Option<String>

Short summary what Operation does.

When used with derive #[utoipa::path(...)] attribute macro the value is taken from first line of doc comment.

§description: Option<String>

Long explanation of Operation behaviour. Markdown syntax is supported.

When used with derive #[utoipa::path(...)] attribute macro the doc comment is used as value for description.

§operation_id: Option<String>

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

When used with derive #[utoipa::path(...)] attribute macro the handler function name will be used by default.

§external_docs: Option<ExternalDocs>

Additional external documentation for this operation.

§parameters: Option<Vec<Parameter>>

List of applicable parameters for this Operation.

§request_body: Option<RequestBody>

Optional request body for this Operation.

§responses: Responses

List of possible responses returned by the Operation.

§callbacks: Option<String>§deprecated: Option<Deprecated>

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

§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.

§servers: Option<Vec<Server>>

Alternative Servers for this Operation.

Implementations§

source§

impl Operation

source

pub fn new() -> Self

Construct a new API Operation.

Trait Implementations§

source§

impl Clone for Operation

source§

fn clone(&self) -> Operation

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Operation

source§

fn default() -> Operation

Returns the “default value” for a type. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Operation> for OperationBuilder

source§

fn from(value: Operation) -> Self

Converts to this type from the input type.
source§

impl From<OperationBuilder> for Operation

source§

fn from(value: OperationBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Operation> for Operation

source§

fn eq(&self, other: &Operation) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Operation

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for Operation

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,