Struct Doc 

pub struct Doc { /* private fields */ }

Per-route OpenAPI annotations stored in route meta.

Implementations

impl Doc

pub fn new() -> Self

pub fn skip() -> Self

Mark the route as intentionally undocumented.

pub fn is_skip(&self) -> bool

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

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

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

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

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

pub fn response(self, status: u16, schema: Value) -> Self

Trait Implementations

impl Clone for Doc

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 Doc

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

Formats the value using the given formatter.

impl Default for Doc

fn default() -> Self

Returns the “default value” for a type.

impl RouteValue for Doc

fn check(&self, _ctx: &BuildCtx<'_>) -> Result<(), String>

Startup validation; default is a no-op.

fn label(&self) -> Cow<'static, str>

Label for explain / CLI check.