Struct Operation 

pub struct Operation {
    pub tags: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub operation_id: Option<String>,
    pub parameters: Vec<Parameter>,
    pub request_body: Option<RequestBody>,
    pub responses: BTreeMap<String, Response>,
    pub deprecated: bool,
    pub security: Vec<BTreeMap<String, Vec<String>>>,
}

A single API operation.

Fields

tags: Vec<String>

Grouping tags.

summary: Option<String>

One-line summary.

description: Option<String>

Longer description.

operation_id: Option<String>

Unique operation id.

parameters: Vec<Parameter>

Parameters (path, query, header, cookie).

request_body: Option<RequestBody>

Request body.

responses: BTreeMap<String, Response>

Responses keyed by status code ("200") or "default".

deprecated: bool

Deprecated flag.

security: Vec<BTreeMap<String, Vec<String>>>

Security requirements.

Implementations

impl Operation

pub fn add_parameter(&mut self, parameter: Parameter)

Add a parameter unless one with the same name and location exists.

Path parameters may be pushed with an empty name; the builder names them positionally from the path template.

pub fn set_request_body( &mut self, media_type: &str, schema: SchemaObject, required: bool, )

Set the request body to schema with the given media type.

pub fn add_response( &mut self, status: impl Into<String>, description: impl Into<String>, content: Option<(&str, SchemaObject)>, )

Add (or replace) a response.

pub fn remap_response(&mut self, from: &str, to: &str)

Move the response documented under from to to (status override).

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a duplicate 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 PartialEq for Operation

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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