Struct RouteDoc 

pub struct RouteDoc {
    pub operation_id: Option<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub tags: Vec<String>,
    pub deprecated: bool,
    pub path_params: Option<Value>,
    pub query: Option<Value>,
    pub request: Option<BodyDoc>,
    pub responses: BTreeMap<u16, ResponseDoc>,
    pub security: Option<Vec<String>>,
}

How a custom route appears in the service’s OpenAPI spec. Schemas are JSON Schema (draft 2020-12) referring to #/components/schemas/….

Fields

operation_id: Option<String>

Defaults to the handler name.

summary: Option<String>

description: Option<String>

tags: Vec<String>

Defaults to the service name.

deprecated: bool

path_params: Option<Value>

An object schema whose properties are the path parameters.

query: Option<Value>

An object schema whose properties are the query parameters.

request: Option<BodyDoc>

responses: BTreeMap<u16, ResponseDoc>

security: Option<Vec<String>>

Security scheme names; None derives them from the posture.

Trait Implementations

impl Clone for RouteDoc

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 RouteDoc

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

Formats the value using the given formatter.

impl Default for RouteDoc

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RouteDoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RouteDoc

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RouteDoc

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 RouteDoc