Struct jsona_openapi::Response
source · [−]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>>>,
}
Expand description
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
sourceimpl<'de> Deserialize<'de> for Response
impl<'de> Deserialize<'de> for Response
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<Response> for Response
impl PartialEq<Response> for Response
impl StructuralPartialEq for Response
Auto Trait Implementations
impl RefUnwindSafe for Response
impl Send for Response
impl Sync for Response
impl Unpin for Response
impl UnwindSafe for Response
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more