pub struct Response {
pub description: Str,
pub headers: IndexMap<Str, ObjectOrReference<Header>>,
pub content: IndexMap<Str, MediaType>,
pub links: IndexMap<Str, 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: Str
A short description of the response. CommonMark syntax MAY be used for rich text representation.
headers: IndexMap<Str, 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: IndexMap<Str, 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: IndexMap<Str, 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.