Struct ApiDoc 

pub struct ApiDoc {

    pub method: &'static str,
    pub path: &'static str,
    pub operation_id: &'static str,
    pub summary: Option<&'static str>,
    pub description: Option<&'static str>,
    pub tags: &'static [&'static str],
    pub path_params: &'static [&'static str],
    pub request_body: Option<SchemaEntry>,
    pub response: Option<SchemaEntry>,
    pub success_status: u16,
    pub hidden: bool,
    pub query_schema: Option<SchemaEntry>,
    pub secured: bool,
    pub required_roles: &'static [&'static str],
    pub register_schemas: Option<fn(&mut SchemaRegistry)>,
    pub api_version: Option<&'static str>,
    pub sunset_opt_out: bool,
    pub has_policy: bool,
    pub mcp_tool: bool,
    pub mcp_exclude: bool,
    pub mcp_stream: bool,
}

OpenAPI metadata emitted alongside every annotated route.

Populated by the route macros (get, post, etc.) from the handler’s path, signature, and any #[api_doc(...)] overrides.

Fields

method: &'static str

HTTP method as an uppercase string (e.g. "GET").

path: &'static str

Raw route path with {param} placeholders (e.g. "/users/{id}").

operation_id: &'static str

Handler function name — used as the default operationId.

summary: Option<&'static str>

Short human-readable summary (from #[api_doc(summary = ...)]).

description: Option<&'static str>

Longer free-form description.

tags: &'static [&'static str]

Grouping tags. Defaults to the first path segment when unset.

path_params: &'static [&'static str]

Path parameter names extracted from the URL template.

Built at compile time from {...} segments in the route path.

request_body: Option<SchemaEntry>

Optional schema for the request body (typically the inner type of a Json<T> extractor).

response: Option<SchemaEntry>

Optional schema for the success response (typically the inner type of a Json<T> return value).

success_status: u16

Success HTTP status code, defaults to 200.

hidden: bool

When true, the route is excluded from the generated spec.

query_schema: Option<SchemaEntry>

Optional query-parameter schema inferred from Query<T> extractors.

secured: bool

True when the route requires authentication (#[secured]).

required_roles: &'static [&'static str]

Roles required by #[secured("role1")]. Empty means any authenticated user.

register_schemas: Option<fn(&mut SchemaRegistry)>

Optional runtime hook that lets a handler register any extra component schemas with the generator.

api_version: Option<&'static str>

Optional API version associated with this route.

sunset_opt_out: bool

Whether this route opts out of sunset 410 responses.

has_policy: bool

Whether this route uses dynamic policy authorization.

mcp_tool: bool

True when the endpoint opts in to MCP tool exposure via #[api_doc(mcp)]. Opt-in is per-endpoint and never implicit.

mcp_exclude: bool

True when the endpoint explicitly opts out of MCP exposure via #[api_doc(mcp = false)]. Honored even under the whole-API hatch (AppBuilder::expose_all_as_mcp). Not an intra-doc link: this field is always compiled, but the builder method is gated behind the mcp feature, so a hard link would break docs built without it.

mcp_stream: bool

True when the endpoint opts in to streaming MCP exposure via #[api_doc(mcp, stream)]. A streaming tool returns an Autumn Sse stream that the MCP endpoint projects onto the Streamable-HTTP SSE channel as notifications/progress messages terminated by the final tools/call result. Because an Sse handler has no JSON response schema, this flag also exempts the tool from the JSON-out eligibility gate that otherwise excludes schema-less routes.

Trait Implementations

impl Clone for ApiDoc

fn clone(&self) -> ApiDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiDoc

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

Formats the value using the given formatter.

impl Default for ApiDoc

fn default() -> ApiDoc

Returns the “default value” for a type.