Skip to content

Commit

Permalink
Update 3.1.0.md (#2405)
Browse files Browse the repository at this point in the history
Improve wording about 'summary' and 'description' in Reference Object
  • Loading branch information
greatvovan authored Nov 12, 2020
1 parent 05de2c4 commit 99eabdf
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions versions/3.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2241,8 +2241,8 @@ A simple object to allow referencing other components in the OpenAPI document, i
Field Name | Type | Description
---|:---:|---
<a name="referenceRef"></a>$ref | `string` | **REQUIRED**. The reference string.
<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.
<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.
<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.
<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.

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

Expand Down

0 comments on commit 99eabdf

Please sign in to comment.