openapi_schema::v3

Struct Operation

pub struct Operation {Show 13 fields
    pub tags: Option<Vec<String>>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_docs: Option<ExternalDoc>,
    pub operation_id: Option<String>,
    pub parameters: Option<Vec<RefOrObject<Parameter>>>,
    pub request_body: Option<RefOrObject<RequestBody>>,
    pub responses: Responses,
    pub callbacks: Option<BTreeMap<String, RefOrObject<Callback>>>,
    pub deprecated: Option<bool>,
    pub security: Option<Vec<SecurityRequirement>>,
    pub servers: Option<Vec<Server>>,
    pub extensions: Extensions,
}

Expand description

§Operation

Describes a single API operation on a path.

Fields§

§tags: Option<Vec<String>>

A list of tags for API documentation control.

§summary: Option<String>

A short summary of what the operation does.

§description: Option<String>

A verbose explanation of the operation behavior.

§external_docs: Option<ExternalDoc>

Additional external documentation for this operation.

§operation_id: Option<String>

Unique string used to identify the operation.

§parameters: Option<Vec<RefOrObject<Parameter>>>

A list of parameters that are applicable for this operation.

§request_body: Option<RefOrObject<RequestBody>>

The request body applicable for this operation.

§responses: Responses

The list of possible responses as they are returned from executing this operation.

§callbacks: Option<BTreeMap<String, RefOrObject<Callback>>>

A map of possible out-of band callbacks related to the parent operation.

§deprecated: Option<bool>

Declares this operation to be deprecated.

§security: Option<Vec<SecurityRequirement>>

A declaration of which security mechanisms can be used for this operation.

§servers: Option<Vec<Server>>

An alternative server array to service this operation.

§extensions: Extensions

Trait Implementations§

impl Clone for Operation

fn clone(&self) -> Operation

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Operation

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

Formats the value using the given formatter. Read more

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. Read more

impl PartialEq for Operation

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

const 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. Read more

impl StructuralPartialEq for Operation

Auto Trait Implementations§

impl Freeze for Operation

impl RefUnwindSafe for Operation

impl Send for Operation

impl Sync for Operation

impl Unpin for Operation

impl UnwindSafe for Operation

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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