Skip to content

Commit 99eabdf

Browse files
authored
Update 3.1.0.md (#2405)
Improve wording about 'summary' and 'description' in Reference Object
1 parent 05de2c4 commit 99eabdf

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

versions/3.1.0.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2241,8 +2241,8 @@ A simple object to allow referencing other components in the OpenAPI document, i
22412241
Field Name | Type | Description
22422242
---|:---:|---
22432243
<a name="referenceRef"></a>$ref | `string` | **REQUIRED**. The reference string.
2244-
<a name="referenceSummary"></a>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.
2245-
<a name="referenceDescription"></a>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.
2244+
<a name="referenceSummary"></a>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.
2245+
<a name="referenceDescription"></a>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.
22462246

22472247
This object cannot be extended with additional properties and any properties added SHALL be ignored.
22482248

0 commit comments

Comments
 (0)