Allow summary and description as $ref siblings (#2181)

OAI · Mar 26, 2020 · cafadc9 · cafadc9
1 parent b45d0d8
commit cafadc9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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
 ---|:---:|---
 <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.
 
 This object cannot be extended with additional properties and any properties added SHALL be ignored.