From f87e13982e92b5cf66ac2a1630bc25c8c1fbc36a Mon Sep 17 00:00:00 2001 From: "Henry H. Andrews" Date: Tue, 27 May 2025 18:10:34 -0700 Subject: [PATCH] Add "summary" field to Response Object --- src/oas.md | 1 + src/schemas/validation/schema.yaml | 2 ++ 2 files changed, 3 insertions(+) diff --git a/src/oas.md b/src/oas.md index 8438fdc14b..d83776bbe3 100644 --- a/src/oas.md +++ b/src/oas.md @@ -1831,6 +1831,7 @@ Describes a single response from an API operation, including design-time, static | Field Name | Type | Description | | ---- | :----: | ---- | +| summary | `string` | A short summary of the meaning of the response. | | description | `string` | A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | | 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. | | 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/*"` | diff --git a/src/schemas/validation/schema.yaml b/src/schemas/validation/schema.yaml index b1b38f2d19..ee6eb0c7ce 100644 --- a/src/schemas/validation/schema.yaml +++ b/src/schemas/validation/schema.yaml @@ -567,6 +567,8 @@ $defs: $comment: https://spec.openapis.org/oas/v3.2#response-object type: object properties: + summary: + type: string description: type: string headers: