Struct Operation 

pub struct Operation { /* private fields */ }

Description of one operation (method + path)

Implementations

impl Operation

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

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

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

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

pub fn deprecated(self) -> Self

pub fn secured(self) -> Self

Requires a bearer token (Authorization: Bearer ...)

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

Requires an API key in the given header (e.g. x-api-key)

pub fn path_param(self, name: &str, schema: Value, description: &str) -> Self

Describe a path parameter (undeclared ones default to string)

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

pub fn header_param( self, name: &str, schema: Value, description: &str, required: bool, ) -> Self

pub fn request_json(self, schema: Value) -> Self

JSON request body with the given schema

pub fn request_form(self, schema: Value) -> Self

application/x-www-form-urlencoded request body

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

Response without a body description

pub fn response_json( self, status: u16, description: &str, schema: Value, ) -> Self

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

Response using the framework’s error body { "error": "...", "status": 404 }

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.