[I] OpenAPIResponse3_2
Extends
Section titled “Extends”Omit<OpenAPI3Response,"content">
Indexable
Section titled “Indexable”[key: `x-${string}`]: anyProperties
Section titled “Properties”| Property | Type | Description | Inherited from |
|---|---|---|---|
content? | Record<string, Refable<OpenAPIMediaType3_2>> | 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. | Omit.description |
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. | Omit.headers |
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. | Omit.links |
summary? | string | A short summary of the meaning of the response. See https://spec.openapis.org/oas/v3.2.0.html#fixed-fields-14 | - |