Struct openapiv3::Operation

pub struct Operation {
    pub tags: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_documentation: Option<ExternalDocumentation>,
    pub operation_id: Option<String>,
    pub parameters: Vec<ReferenceOr<Parameter>>,
    pub request_body: Option<ReferenceOr<RequestBody>>,
    pub responses: Responses,
    pub deprecated: bool,
    pub security: Vec<SecurityRequirement>,
    pub servers: Vec<Server>,
    pub extensions: IndexMap<String, Value>,
}

Describes a single API operation on a path.

Fields

tags: 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. CommonMark syntax MAY be used for rich text representation.

external_documentation: Option<ExternalDocumentation>

Additional external documentation for this operation.

operation_id: Option<String>

Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

parameters: Vec<ReferenceOr<Parameter>>

A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.

request_body: Option<ReferenceOr<RequestBody>>

The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.

responses: Responses

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

deprecated: bool

Declares this operation to be deprecated.Default value is false.

security: Vec<SecurityRequirement>

A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.

servers: Vec<Server>

An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value.

extensions: IndexMap<String, Value>

Inline extensions to this object.

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 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: &Operation) -> bool

This method tests for !=.

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