OasResponse

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

Members

Variables

content
OasMediaType[string] content;

A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix--d) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

description
string description;

**REQUIRED**. A short description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.

headers
OasHeader[string] headers;

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.

links
OasLink[string] links;

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 OasComponent objects.

ref_
string ref_;

An internal or external reference to a response component. If set, the other attribute are unused.

See Also

Meta