Skip to content

Commit cafadc9

Browse files
authored
Allow summary and description as $ref siblings (#2181)
1 parent b45d0d8 commit cafadc9

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

versions/3.1.0.md

+2
Original file line numberDiff line numberDiff line change
@@ -2251,6 +2251,8 @@ A simple object to allow referencing other components in the OpenAPI document, i
22512251
Field Name | Type | Description
22522252
---|:---:|---
22532253
<a name="referenceRef"></a>$ref | `string` | **REQUIRED**. The reference string.
2254+
<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.
2255+
<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.
22542256

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

0 commit comments

Comments
 (0)