Struct Operation 

pub struct Operation {

    pub tags: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_docs: Option<ExternalDocumentation>,
    pub operation_id: Option<String>,
    pub parameters: Vec<RefOr<Parameter>>,
    pub request_body: Option<RefOr<RequestBody>>,
    pub responses: Responses,
    pub callbacks: Map<RefOr<Callback>>,
    pub deprecated: Option<bool>,
    pub security: Option<Vec<SecurityRequirement>>,
    pub servers: Vec<Server>,
    pub extensions: Extensions,
}

A single API operation on a path.

Fields

tags: Vec<String>

Tags for grouping this operation.

summary: Option<String>

A short summary of what the operation does.

description: Option<String>

A verbose explanation. CommonMark syntax may be used.

external_docs: Option<ExternalDocumentation>

Additional external documentation.

operation_id: Option<String>

A case-sensitive identifier, unique across the whole description.

Optional per the specification, but Kynos always emits one: it is what client generators name their methods after, and what a Link refers to.

parameters: Vec<RefOr<Parameter>>

Parameters applying to this operation.

An entry here with the same name and location as one on the enclosing PathItem overrides it, but cannot remove it.

request_body: Option<RefOr<RequestBody>>

The request body.

responses: Responses

The responses this operation may return.

callbacks: Map<RefOr<Callback>>

Out-of-band requests made as part of this operation.

deprecated: Option<bool>

Whether this operation is deprecated.

security: Option<Vec<SecurityRequirement>>

The security requirements, overriding the document-level list.

An empty vector is not the same as absent: it removes the document-level requirement, making the operation anonymous.

servers: Vec<Server>

Servers serving this operation, overriding wider declarations.

extensions: Extensions

Specification extensions.

Implementations

impl Operation

pub fn new(operation_id: impl Into<String>) -> Self

Creates an operation identified by operation_id.

pub fn with_summary(self, summary: impl Into<String>) -> Self

Sets the summary.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

pub fn with_tag(self, tag: impl Into<String>) -> Self

Adds a tag.

pub fn with_parameter(self, parameter: Parameter) -> Self

Adds a parameter.

pub fn with_request_body(self, body: RequestBody) -> Self

Sets the request body.

pub fn with_responses(self, responses: Responses) -> Self

Sets the responses.

pub fn with_security(self, requirement: SecurityRequirement) -> Self

Adds a security requirement.

pub fn deprecated(self) -> Self

Marks the operation deprecated.

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Self

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() -> 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 PartialEq for Operation

fn eq(&self, other: &Self) -> 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