Skip to content

Commit 6a4949a

Browse files
authored
Merge pull request #4630 from handrews/resp-sum
v3.2: Add "summary" field to Response Object
2 parents 5cd7bc1 + f87e139 commit 6a4949a

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

src/oas.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1831,6 +1831,7 @@ Describes a single response from an API operation, including design-time, static
18311831

18321832
| Field Name | Type | Description |
18331833
| ---- | :----: | ---- |
1834+
| <a name="response-summary"></a>summary | `string` | A short summary of the meaning of the response. |
18341835
| <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. |
18351836
| <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. |
18361837
| <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/*"` |

src/schemas/validation/schema.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,8 @@ $defs:
567567
$comment: https://spec.openapis.org/oas/v3.2#response-object
568568
type: object
569569
properties:
570+
summary:
571+
type: string
570572
description:
571573
type: string
572574
headers:

0 commit comments

Comments
 (0)