Response

class Response(d: dict[str, Any] = None, description: str = None, headers: dict[str, Header | Reference] = None, content: dict[str, MediaType] = None, links: dict[str, Link | Reference] = None)

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

property description: str

REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation.

property headers: dict[str, Header | Reference] | None

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.

property content: dict[str, MediaType] | None

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/*".

property links: dict[str, Link | Reference] | None

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.