Struct Response 

#[non_exhaustive]
pub struct Response {
    pub summary: Option<String>,
    pub description: String,
    pub headers: PropMap<String, Header>,
    pub contents: IndexMap<String, Content>,
    pub extensions: PropMap<String, Value>,
    pub links: PropMap<String, RefOr<Link>>,
}

Implements OpenAPI Response Object.

Response is api operation response.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

summary: Option<String>

Short summary of the meaning of the response. Added in OpenAPI 3.2.

See https://spec.openapis.org/oas/v3.2.0.html#response-object.

description: String

Description of the response. Response support markdown syntax.

Required in OpenAPI 3.1 and optional as of OpenAPI 3.2, so documents that omit it deserialize into an empty String. It is always serialized — an empty description is valid under both versions, whereas omitting it would be invalid 3.1.

headers: PropMap<String, Header>

Map of headers identified by their name. Content-Type header will be ignored.

contents: IndexMap<String, Content>

Map of response Content objects identified by response body content type e.g application/json.

Contents are stored within IndexMap to retain their insertion order. Swagger UI will create and show default example according to the first entry in content map.

extensions: PropMap<String, Value>

Optional extensions “x-something”

links: PropMap<String, RefOr<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.

Implementations

impl Response

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

Construct a new Response.

Function takes description as argument.

pub fn description<I: Into<String>>(self, description: I) -> Self

Add description. Description supports markdown syntax.

pub fn summary<I: Into<String>>(self, summary: I) -> Self

Add a short summary of the meaning of the response. Requires OpenAPI 3.2.

pub fn add_content<S: Into<String>, C: Into<Content>>( self, key: S, content: C, ) -> Self

Add Content of the Response with content type e.g application/json and returns Self.

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

Add response Header and returns Self.

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

Add openapi extension (x-something) for Response.

pub fn add_link<S: Into<String>, L: Into<RefOr<Link>>>( self, name: S, link: L, ) -> Self

Add link that can be followed from the response.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

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() -> 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

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