Skip to content

Commit 267aaa1

Browse files
authored
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.
1 parent b0ecc00 commit 267aaa1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

versions/3.0.3.md

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

733733
Field Name | Type | Description
734734
---|:---:|---
735-
<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*.
735+
<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). A Path Item Object containing a `$ref` property is **not** a [Reference Object](#referenceObject). The properties of the referenced structure are merged with the local Path Item Object. If the same property exists in both, the referenced structure and the local one, this is a conflict. In this case the behavior is *undefined*.
736736
<a name="pathItemSummary"></a>summary| `string` | An optional, string summary, intended to apply to all operations in this path.
737737
<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.
738738
<a name="pathItemGet"></a>get | [Operation Object](#operationObject) | A definition of a GET operation on this path.

0 commit comments

Comments
 (0)