Struct Response 

pub struct Response {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub headers: Map<RefOr<Header>>,
    pub content: Map<MediaType>,
    pub links: Map<RefOr<Link>>,
    pub extensions: Extensions,
}

A single response.

Fields

summary: Option<String>

A short summary of the response.

Introduced in OpenAPI 3.2. Under 3.1 the first line of the description serves this purpose.

description: Option<String>

A description of the response. CommonMark syntax may be used.

Required by 3.1, optional in 3.2. 3.1 marks it REQUIRED; 3.2 drops the marker, so a response stating only a summary is a legal 3.2 document. Modelling it as a String enforced 3.1’s rule on both versions and made such a document unparseable, so the requirement lives in validate instead, where it is checked against the version the document claims.

new sets it, which is the common case and the only one 3.1 admits.

headers: Map<RefOr<Header>>

Headers sent with the response.

A Content-Type entry is ignored, since content states it.

content: Map<MediaType>

The response body’s representations, keyed by media type.

links: Map<RefOr<Link>>

Design-time links to other operations.

extensions: Extensions

Specification extensions.

Implementations

impl Response

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

Creates a response with no body.

pub fn with_content( description: impl Into<String>, media_type: impl Into<String>, content: MediaType, ) -> Self

Creates a response with one body representation.

pub fn with_header(self, name: impl Into<String>, header: Header) -> Self

Declares a response header.

pub fn with_link(self, name: impl Into<String>, link: Link) -> Self

Declares a link to another operation.

pub fn with_extension( self, key: impl Into<String>, value: impl Into<Value>, ) -> Self

Attaches an extension field.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Self

Returns a duplicate 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() -> Self

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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

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