Struct openapi::v3_0::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 parameters: Option<Vec<ObjectOrReference<Parameter>>>,
    pub request_body: Option<ObjectOrReference<RequestBody>>,
    pub responses: BTreeMap<String, Response>,
    pub callbacks: Option<BTreeMap<String, Callback>>,
    pub deprecated: Option<bool>,
    pub servers: Option<Vec<Server>>,
    pub extensions: Extensions,
}

Describes a single API operation on a path.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#operationObject.

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

external_docs: Option<ExternalDoc>

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: Option<Vec<ObjectOrReference<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<ObjectOrReference<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: BTreeMap<String, Response>

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

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.

The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.

The default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.

The Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful operation call.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#responsesObject.

callbacks: Option<BTreeMap<String, Callback>>

A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.

deprecated: Option<bool>

Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.

servers: Option<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: 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 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