Struct openapi_schema::v2::Operation

pub struct Operation {

    pub tags: Option<Vec<String>>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_docs: Option<ExternalDoc>,
    pub operation_id: Option<String>,
    pub consumes: Option<Vec<String>>,
    pub produces: Option<Vec<String>>,
    pub parameters: Option<Vec<ParameterOrRef>>,
    pub responses: Responses,
    pub schemas: Option<TransferProtocol>,
    pub deprecated: Option<String>,
    pub security: Option<Vec<SecurityRequirementObject>>,
    pub extensions: Extensions,
}

Operation

Describes a single API operation on a path.

Fields

tags: Option<Vec<String>>

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

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.

consumes: Option<Vec<String>>

A list of MIME types the operation can consume.

produces: Option<Vec<String>>

A list of MIME types the operation can produce.

parameters: Option<Vec<ParameterOrRef>>

A list of parameters that are applicable for this operation.

responses: Responses

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

schemas: Option<TransferProtocol>

The transfer protocol for the operation.

deprecated: Option<String>

Declares this operation to be deprecated.

security: Option<Vec<SecurityRequirementObject>>

A declaration of which security schemes are applied for this operation.

extensions: Extensions

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<'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 PartialEq<Operation> for Operation

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

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

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.

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