[T] OpenAPI3Response
type OpenAPI3Response = Extensions & object;Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
content? | Record<string, OpenAPI3MediaType> | 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/* |
description | string | A short description of the response. CommonMark syntax MAY be used for rich text representation. |
headers? | Record<string, Refable<OpenAPI3Header>> | 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? | Record<string, Refable<OpenAPI3Link>> | 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. |