Struct Operation 

pub struct Operation {

    pub tags: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_docs: Option<ExternalDoc>,
    pub operation_id: Option<String>,
    pub parameters: Vec<ObjectOrReference<Parameter>>,
    pub request_body: Option<ObjectOrReference<RequestBody>>,
    pub responses: Option<BTreeMap<String, ObjectOrReference<Response>>>,
    pub callbacks: BTreeMap<String, Callback>,
    pub deprecated: Option<bool>,
    pub security: Vec<SecurityRequirement>,
    pub servers: Vec<Server>,
    pub extensions: BTreeMap<String, Value>,
}

Describes a single API operation on a path.

Fields

tags: Vec<String>

summary: Option<String>

description: Option<String>

external_docs: Option<ExternalDoc>

operation_id: Option<String>

parameters: Vec<ObjectOrReference<Parameter>>

request_body: Option<ObjectOrReference<RequestBody>>

responses: Option<BTreeMap<String, ObjectOrReference<Response>>>

callbacks: BTreeMap<String, Callback>

deprecated: Option<bool>

security: Vec<SecurityRequirement>

servers: Vec<Server>

extensions: BTreeMap<String, Value>

Implementations

impl Operation

pub fn request_body( &self, spec: &OpenApiV32Spec, ) -> Result<Option<RequestBody>, ErrorSpec>

Resolves and returns this operation’s request body.

pub fn responses(&self, spec: &OpenApiV32Spec) -> BTreeMap<String, Response>

Resolves and returns map of this operation’s responses, keyed by status code.

pub fn parameters( &self, spec: &OpenApiV32Spec, ) -> Result<Vec<Parameter>, ErrorSpec>

Resolves and returns list of this operation’s parameters.

pub fn parameter( &self, search: &str, spec: &OpenApiV32Spec, ) -> Result<Option<Parameter>, ErrorSpec>

Finds, resolves, and returns one of this operation’s parameters by name.

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<'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 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