From 936889897446581eeab62c007dd6c9db47f3fcc1 Mon Sep 17 00:00:00 2001 From: Vladimir Date: Mon, 9 Nov 2020 15:49:26 -0800 Subject: [PATCH] Update 3.1.0.md Improve wording about 'summary' and 'description' in Reference Object --- versions/3.1.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versions/3.1.0.md b/versions/3.1.0.md index 0626ea9267..b037e43073 100644 --- a/versions/3.1.0.md +++ b/versions/3.1.0.md @@ -2241,8 +2241,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. +summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow 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 allow a `description` field, then this field has no effect. This object cannot be extended with additional properties and any properties added SHALL be ignored.