From 5786d452553a3277d29137cc691cd1a298ea8036 Mon Sep 17 00:00:00 2001 From: Mike Ralphson Date: Thu, 19 Mar 2020 21:39:54 +0000 Subject: [PATCH] Allow summary and description as $ref siblings --- versions/3.1.0.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/versions/3.1.0.md b/versions/3.1.0.md index 79d3105562..4dde438fbf 100644 --- a/versions/3.1.0.md +++ b/versions/3.1.0.md @@ -2251,6 +2251,8 @@ A simple object to allow referencing other components in the OpenAPI document, i Field Name | Type | Description ---|:---:|--- $ref | `string` | **REQUIRED**. The reference string. +summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not define a `summary` field, then this field has no effect. +description | `string` | A description which by default SHOULD override that of the referenced component. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. If the referenced object-type does not define a `description` field, then this field has no effect. This object cannot be extended with additional properties and any properties added SHALL be ignored.