Skip to content

Commit 7a205a1

Browse files
cebewebron
authored andcommitted
Explain unclear semantics of property $ref in Path Item Object (OAI#1964)
* Explain unclear semantics of property `$ref` in Path Item Object Currently, as explained in OAI#1038 (comment) the description of `$ref` in [Path Item Object](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#pathItemObject) is unclear about the semantics behing it. I took the explaination from issue OAI#1038 to make it more clear. * Update versions/3.1.0.md Co-authored-by: Ron <ron@swagger.io> Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
1 parent 8f4c279 commit 7a205a1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

versions/3.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@ The path itself is still exposed to the documentation viewer but they will not k
740740

741741
Field Name | Type | Description
742742
---|:---:|---
743-
<a name="pathItemRef"></a>$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#pathItemObject). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is *undefined*.
743+
<a name="pathItemRef"></a>$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#pathItemObject). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined.
744744
<a name="pathItemSummary"></a>summary| `string` | An optional, string summary, intended to apply to all operations in this path.
745745
<a name="pathItemDescription"></a>description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
746746
<a name="pathItemGet"></a>get | [Operation Object](#operationObject) | A definition of a GET operation on this path.

0 commit comments

Comments
 (0)