Struct Operation 

pub struct Operation { /* private fields */ }

Available on crate feature openapi only.

What a client needs to know about one operation beyond its method and path. Schemas are JSON text, normally from JsonSchema.

Implementations

impl Operation

pub fn new(summary: impl Into<String>) -> Operation

An operation with a one-line summary.

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

A longer description (CommonMark).

pub fn operation_id(self, id: impl Into<String>) -> Operation

A unique operationId (client generators name methods after it).

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

Group the operation under tag.

pub fn deprecated(self) -> Operation

Mark the operation deprecated.

pub fn path_param<T>(self, name: &str) -> Operation

where T: JsonSchema + ?Sized,

Path parameter name holds a T (default: a string).

pub fn path_param_schema( self, name: &str, schema: &str, description: &str, ) -> Operation

Path parameter name with an explicit schema and description.

pub fn query<T>(self) -> Operation

where T: JsonSchema + ?Sized,

Query parameters: one per property of T (a struct), required as the struct requires them — the type a handler parses the query into.

pub fn query_param(self, name: &str, schema: &str, required: bool) -> Operation

One query parameter with an explicit schema.

pub fn body<T>(self) -> Operation

where T: JsonSchema + ?Sized,

A required application/json request body holding a T.

pub fn body_schema( self, content_type: &str, schema: &str, required: bool, ) -> Operation

A request body of content_type with an explicit schema.

pub fn response<T>(self, status: u16, description: &str) -> Operation

where T: JsonSchema + ?Sized,

Response status with an application/json body holding a T.

pub fn response_schema( self, status: u16, description: &str, content_type: &str, schema: &str, ) -> Operation

Response status with a body of content_type and an explicit schema.

pub fn status(self, status: u16, description: &str) -> Operation

Response status without a documented body (an error, 204, …).

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<(), Error>

Formats the value using the given formatter.

impl Default for Operation

fn default() -> Operation

Returns the “default value” for a type.