Struct Operation 

pub struct Operation { /* private fields */ }

One documented operation: a method on a path.

Everything is optional. An operation with nothing set still appears in the document, which is the point of seeding from the router: an undocumented endpoint shows up as an endpoint rather than as nothing.

Implementations

impl Operation

pub fn new() -> Self

An operation with nothing described yet.

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

A one-line summary, shown as the operation’s title in most viewers.

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

A longer description. CommonMark is allowed by the specification.

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

An explicit operationId.

Client generators use it for the generated method name. Left unset, one is derived from the method and path, which is stable as long as the route is.

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

Group the operation under a tag.

pub fn deprecated(self) -> Self

Mark the operation deprecated.

pub fn query(self, name: impl Into<String>, required: bool) -> Self

Document a query parameter.

pub fn query_described( self, name: impl Into<String>, required: bool, description: impl Into<String>, ) -> Self

Document a query parameter with a description.

pub fn accepts(self, media_type: impl Into<String>) -> Self

Document the request body’s media type, with no schema.

pub fn schema(self, media_type: impl Into<String>, schema: Value) -> Self

Document the request body with a JSON Schema.

The schema is any serde_json::Value, so one produced by schemars or written by hand fits equally well.

pub fn response(self, status: u16, description: impl Into<String>) -> Self

Document a response status and what it means.

pub fn response_schema( self, status: u16, description: impl Into<String>, schema: Value, ) -> Self

Document a response with a JSON Schema for its body.

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.