Struct RouteDescription 

pub struct RouteDescription {

    pub group: String,
    pub name: String,
    pub description: String,
    pub request_body: Option<DtoEntity>,
    pub response_examples: HashMap<u16, DtoEntity>,
    pub headers: HashMap<String, String>,
    pub path_parameters: HashMap<String, String>,
    pub path_parameter_defaults: HashMap<String, String>,
    pub query_parameters: HashMap<String, String>,
    pub query_parameter_defaults: HashMap<String, String>,
    pub file_parameters: HashMap<String, FileParameter>,
    pub rate_limit: Option<u32>,
    pub authentication_required: bool,
    pub authentication_comment: Option<String>,
    pub summary: String,
    pub tags: Vec<String>,
    pub is_deprecated: bool,
}

Declarative metadata for one route: documentation, validation, and policy. A description is registered for docs generation, declares the expected request body (required when has_body is set on mount), response examples, params, file parts, rate limit, and auth notes. Build with the new constructor and the group / with_body / response / header / query_param builders.

Fields

group: String

Documentation group this route belongs to; also seeds the default tag.

name: String

Route name; kept in sync with summary by RouteDescription::name.

description: String

Long-form description shown in documentation.

request_body: Option<DtoEntity>

Declared request-body DTO schema and example, if the route takes a body.

response_examples: HashMap<u16, DtoEntity>

Response examples keyed by HTTP status code.

headers: HashMap<String, String>

Documented request headers as name-to-description pairs.

path_parameters: HashMap<String, String>

Documented path parameters as name-to-description pairs.

path_parameter_defaults: HashMap<String, String>

Default values for documented path parameters.

query_parameters: HashMap<String, String>

Documented query parameters as name-to-description pairs.

query_parameter_defaults: HashMap<String, String>

Default values for documented query parameters.

file_parameters: HashMap<String, FileParameter>

Declared multipart file parameters keyed by part name.

rate_limit: Option<u32>

Per-route request cap; None means no route-level limit is installed.

authentication_required: bool

Whether callers must authenticate; enforced by middleware, not by this struct.

authentication_comment: Option<String>

Optional note explaining the authentication requirement.

summary: String

Short summary shown in documentation; defaults to the name.

tags: Vec<String>

Documentation tags used for grouping; defaults to the group name.

is_deprecated: bool

Marks the route as deprecated in documentation.

Implementations

impl RouteDescription

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

Creates a description with the given summary; group and tags default to "Default".

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

Sets the documentation group and resets the tag list to that group.

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

Sets the route name and copies it into the summary.

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

Sets the long-form description shown in documentation.

pub fn with_rate_limit(self, limit: u32) -> Self

Sets the per-route request cap enforced by the router’s rate-limit middleware.

pub fn rate_limit(self, limit: u32) -> Self

Sets the per-route request cap (alias for RouteDescription::with_rate_limit).

pub fn with_body<T>(self) -> Self

where T: DocumentableDTO + Validate,

Declares the request-body DTO type T: records its JSON Schema and example. Required when the route is mounted with has_body; T must also be validatable.

pub fn authentication(self, required: bool) -> Self

Records whether callers must authenticate (informational; enforced by middleware).

pub fn response<T>(self, code: u16) -> Self

where T: DocumentableDTO,

Records a response example for code using DTO type T’s schema and example.

pub fn authentication_required(self, required: bool) -> Self

Records whether callers must authenticate (alias for RouteDescription::authentication).

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

Attaches an explanatory note about the authentication requirement.

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

Documents one expected request header as a name-to-description entry.

pub fn path_param(self, k: impl Into<String>, v: impl Into<String>) -> Self

Documents one path parameter as a name-to-description entry.

pub fn path_param_with_default( self, k: impl Into<String>, v: impl Into<String>, default: impl Into<String>, ) -> Self

Documents one path parameter together with its default value.

pub fn query_param(self, k: impl Into<String>, v: impl Into<String>) -> Self

Documents one query parameter as a name-to-description entry.

pub fn query_param_with_default( self, k: impl Into<String>, v: impl Into<String>, default: impl Into<String>, ) -> Self

Documents one query parameter together with its default value.

pub fn file_param( self, name: impl Into<String>, description: impl Into<String>, file_type: FileParameterType, ) -> Self

Declares an accepted multipart file part without total send caps.

pub fn file_param_with_limit( self, name: impl Into<String>, description: impl Into<String>, file_type: FileParameterType, limit: u32, count: u32, ) -> Self

Declares an accepted multipart file part with sending limits. Panics if limit or count is zero; a count overrun rejects the request with a 400.

pub fn deprecated(self, deprecated: bool) -> Self

Marks the route as deprecated (true) or not (false) in documentation.

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

Adds a documentation tag unless it is already present.

pub fn effective_rate_limit(&self, global: Option<u32>) -> Option<u32>

Returns the per-route limit when set, otherwise the given global limit.

Trait Implementations

impl Clone for RouteDescription

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 RouteDescription

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

Formats the value using the given formatter.

impl Default for RouteDescription

fn default() -> Self

Returns the “default value” for a type.