Skip to content

Commit d2c3bdb

Browse files
authored
Merge pull request #4500 from ralfhandl/3.2-response-object-description-not-required
3.2 Response Object description not required
2 parents a794bc6 + b7a2d9f commit d2c3bdb

File tree

2 files changed

+1
-3
lines changed

2 files changed

+1
-3
lines changed

src/oas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2019,7 +2019,7 @@ Describes a single response from an API operation, including design-time, static
20192019

20202020
| Field Name | Type | Description |
20212021
| ---- | :----: | ---- |
2022-
| <a name="response-description"></a>description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. |
2022+
| <a name="response-description"></a>description | `string` | A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. |
20232023
| <a name="response-headers"></a>headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.1) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. |
20242024
| <a name="response-content"></a>content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://www.rfc-editor.org/rfc/rfc9110.html#appendix-A) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` |
20252025
| <a name="response-links"></a>links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). |

src/schemas/validation/schema.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -557,8 +557,6 @@ $defs:
557557
type: object
558558
additionalProperties:
559559
$ref: '#/$defs/link-or-reference'
560-
required:
561-
- description
562560
$ref: '#/$defs/specification-extensions'
563561
unevaluatedProperties: false
564562

0 commit comments

Comments
 (0)