Struct Operation

pub struct Operation<P, R> {
    pub operation_id: Option<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub consumes: Option<BTreeSet<MediaRange>>,
    pub produces: Option<BTreeSet<MediaRange>>,
    pub security: Vec<BTreeMap<String, Vec<String>>>,
    pub schemes: BTreeSet<OperationProtocol>,
    pub responses: BTreeMap<String, Either<Reference, R>>,
    pub parameters: Vec<Either<Reference, P>>,
    pub deprecated: bool,
    pub tags: Vec<String>,
}

Operation object.

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

Fields

operation_id: Option<String>

summary: Option<String>

description: Option<String>

consumes: Option<BTreeSet<MediaRange>>

produces: Option<BTreeSet<MediaRange>>

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

schemes: BTreeSet<OperationProtocol>

responses: BTreeMap<String, Either<Reference, R>>

parameters: Vec<Either<Reference, P>>

deprecated: bool

tags: Vec<String>

Implementations

impl<S> Operation<Parameter<S>, Response<S>>

pub fn set_parameter_names_from_path_template(&mut self, path: &str)

Overwrites the names of parameters in this operation using the given path template.

Trait Implementations

impl<P: Clone, R: Clone> Clone for Operation<P, R>

fn clone(&self) -> Operation<P, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug, R: Debug> Debug for Operation<P, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: Default, R: Default> Default for Operation<P, R>

fn default() -> Operation<P, R>

Returns the “default value” for a type.

impl<'de, P, R> Deserialize<'de> for Operation<P, R>

where P: Deserialize<'de>, R: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Operation<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>>> for Operation

fn from(v2: Operation<DefaultParameterRaw, DefaultResponseRaw>) -> Self

Converts to this type from the input type.

impl<P, R> Serialize for Operation<P, R>

where P: Serialize, R: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.