Struct Responses

pub struct Responses {
    pub default: Option<ReferenceOr<Response>>,
    pub responses: BTreeMap<String, ReferenceOr<Response>>,
    pub extensions: IndexMap<String, Value>,
}

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.

The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.

The default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.

The Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful operation call.

Fields

default: Option<ReferenceOr<Response>>

The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A Reference Object can link to a response that the OpenAPI Object’s components/responses section defines.

responses: BTreeMap<String, ReferenceOr<Response>>

extensions: IndexMap<String, Value>

This object MAY be extended with Specification Extensions.

Trait Implementations

impl Clone for Responses

fn clone(&self) -> Responses

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Responses

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

Formats the value using the given formatter.

impl Default for Responses

fn default() -> Responses

Returns the “default value” for a type.

impl Serialize for Responses

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

where __S: Serializer,

Serialize this value into the given Serde serializer.