pub struct Operation {
pub tags: Vec<String>,
pub summary: Option<String>,
pub operation_id: Option<String>,
pub description: Option<String>,
pub deprecated: bool,
pub security: Vec<BTreeMap<String, Vec<String>>>,
pub request_body: Option<RequestBody>,
pub responses: BTreeMap<u16, Response>,
pub parameters: BTreeMap<String, OperationParameter>,
pub callbacks: BTreeMap<String, CallbackObject>,
}
Expand description
Operation Object
Fields§
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
operation_id: Option<String>
Unique string used to identify the operation.
description: Option<String>
A verbose explanation of the operation behavior
deprecated: bool
Declares this operation to be deprecated
security: Vec<BTreeMap<String, Vec<String>>>
A declaration of which security mechanisms can be used for this operation
request_body: Option<RequestBody>
The request body applicable for this operation
responses: BTreeMap<u16, Response>
The list of possible responses as they are returned from executing this operation
parameters: BTreeMap<String, OperationParameter>
A list of parameters that are applicable for this operation
callbacks: BTreeMap<String, CallbackObject>
A map of possible out-of band callbacks related to this operation