Struct ErrorResponseRules 

pub struct ErrorResponseRules { /* private fields */ }

Error responses and response headers to document on every matching operation, as data.

A status rule adds a response with the shared ErrorEnvelope schema and the product’s description when the operation does not document that status yet. A header rule adds a header to the selected inline responses when they do not have a header of that name, compared without regard to case. Responses given as a $ref are left unchanged, because they are shared components. Applying the same rules twice changes nothing.

Implementations

impl ErrorResponseRules

pub fn new() -> Self

Creates an empty rule set.

pub fn status( self, condition: OperationCondition, status: u16, description: impl Into<String>, ) -> Self

Adds an error response with this status and description to operations that match.

pub fn header( self, condition: OperationCondition, responses: ResponseSelector, name: impl Into<String>, header: Header, ) -> Self

Adds a response header to the selected responses of operations that match.

pub fn standard_headers(self) -> Self

Adds the headers that baukit-http and baukit-auth send: X-Request-Id on every response, Retry-After on 429, and WWW-Authenticate on 401.

pub fn apply(&self, document: &mut OpenApi)

Applies the rules to every operation in the document.

pub fn apply_where( &self, document: &mut OpenApi, include: impl Fn(&str, &HttpMethod) -> bool, )

Applies the rules to the operations whose path template and method pass include.

Use it for statuses only some routes return, such as a 412 on conditional writes, or to skip public documents such as the OpenAPI route itself.

Trait Implementations

impl Clone for ErrorResponseRules

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ErrorResponseRules

fn default() -> Self

Returns the “default value” for a type.