Struct Response

pub struct Response {
    pub description: String,
    pub headers: Option<IndexMap<String, ObjectOrReference<Header>>>,
    pub content: Option<IndexMap<String, MediaType>>,
    pub links: Option<IndexMap<String, ObjectOrReference<Link>>>,
}

Describes a single response from an API Operation, including design-time, static links to operations based on the response.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#responseObject.

Fields

description: String

A short description of the response. CommonMark syntax MAY be used for rich text representation.

headers: Option<IndexMap<String, ObjectOrReference<Header>>>

Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored.

content: Option<IndexMap<String, MediaType>>

A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

links: Option<IndexMap<String, ObjectOrReference<Link>>>

A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Response

fn eq(&self, other: &Response) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Response

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Response