Struct ResponseContribution 

pub struct ResponseContribution {
    pub status: String,
    pub description: String,
    pub schema_ref: Option<String>,
}

One extra response status the layer can return (e.g. 401 from auth middleware, 429 from a rate limiter). Skipped on operations that already declare a response with the same status — handler-level declarations always win.

Fields

status: String

Status code as a string (e.g. "401", "default").

description: String

Human description rendered in the docs UI.

schema_ref: Option<String>

Optional $ref path for the response body schema (e.g. "#/components/schemas/ApiErrorBody"). Set via ResponseContribution::with_schema_ref.

Implementations

impl ResponseContribution

pub fn new(status: impl Into<String>, description: impl Into<String>) -> Self

Build a response contribution with the given status and description.

pub fn unauthorized() -> Self

Convenience constructor for the standard 401 Unauthorized response.

pub fn forbidden() -> Self

Convenience constructor for the standard 403 Forbidden response.

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

Set the $ref path for the response body schema.

Trait Implementations

impl Clone for ResponseContribution

fn clone(&self) -> ResponseContribution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseContribution

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

Formats the value using the given formatter.