Struct Operation

pub struct Operation {

    pub tags: Vec<String>,
    pub summary: String,
    pub description: String,
    pub external_docs: Option<ExternalDocumentation>,
    pub operation_id: String,
    pub consumes: Vec<String>,
    pub produces: Vec<String>,
    pub responses: HashMap<String, Response>,
    pub schemes: Vec<i32>,
    pub deprecated: bool,
    pub security: Vec<SecurityRequirement>,
    pub extensions: HashMap<String, Value>,
    pub parameters: Option<Parameters>,
}

Operation is a representation of OpenAPI v2 specification’s Operation object.

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

Example:

service EchoService { rpc Echo(SimpleMessage) returns (SimpleMessage) { option (google.api.http) = { get: “/v1/example/echo/{id}” };

  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
    summary: "Get a message.";
    operation_id: "getMessage";
    tags: "echo";
    responses: {
      key: "200"
        value: {
        description: "OK";
      }
    }
  };
}

}

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: String

A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.

description: String

A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.

external_docs: Option<ExternalDocumentation>

Additional external documentation for this operation.

operation_id: 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.

consumes: Vec<String>

A list of MIME types the operation can consume. This overrides the consumes definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.

produces: Vec<String>

A list of MIME types the operation can produce. This overrides the produces definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.

responses: HashMap<String, Response>

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

schemes: Vec<i32>

The transfer protocol for the operation. Values MUST be from the list: “http”, “https”, “ws”, “wss”. The value overrides the OpenAPI Object schemes definition.

deprecated: bool

Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.

security: Vec<SecurityRequirement>

A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.

extensions: HashMap<String, Value>

Custom properties that start with “x-” such as “x-foo” used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

parameters: Option<Parameters>

Custom parameters such as HTTP request headers. See: https://swagger.io/docs/specification/2-0/describing-parameters/ and https://swagger.io/specification/v2/#parameter-object.

Implementations

impl Operation

pub fn schemes( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<Scheme>>

Returns an iterator which yields the valid enum values contained in schemes.

pub fn push_schemes(&mut self, value: Scheme)

Appends the provided enum value to schemes.

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() -> Self

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 Message for Operation

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Operation

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

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

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.

impl StructuralPartialEq for Operation