Struct RouteDocumentation 

pub struct RouteDocumentation {
    pub method: String,
    pub path: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub tags: Vec<String>,
    pub responses: Vec<RouteResponseDocumentation>,
    pub requires_auth: bool,
    pub required_roles: Vec<String>,
}

Fields

method: String

path: String

summary: Option<String>

description: Option<String>

tags: Vec<String>

responses: Vec<RouteResponseDocumentation>

requires_auth: bool

required_roles: Vec<String>

Implementations

impl RouteDocumentation

pub fn new(method: impl Into<String>, path: impl Into<String>) -> Self

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

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

pub fn with_tags<I, S>(self, tags: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

pub fn with_responses(self, responses: Vec<RouteResponseDocumentation>) -> Self

pub fn requires_auth(self) -> Self

pub fn with_required_roles<I, S>(self, roles: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Trait Implementations

impl Clone for RouteDocumentation

fn clone(&self) -> RouteDocumentation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RouteDocumentation

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

Formats the value using the given formatter.

impl Default for RouteDocumentation

fn default() -> RouteDocumentation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RouteDocumentation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RouteDocumentation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.