From 17970c58b78decac08e28a3db3d0c54382748258 Mon Sep 17 00:00:00 2001 From: Vladimir Gorej Date: Thu, 10 Mar 2022 18:43:09 +0100 Subject: [PATCH] Deprecate Path Item Object ref field (#2635) (#2656) * Deprecate Path Item Object ref field (#2635) The field has been deprecated in favor of using Reference Object in OAS 3.2.0 and forward. Signed-off-by: Vladimir Gorej * Deprecate Path Item Object ref field specific usecases Refs #2635 * fix change --- versions/3.1.1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versions/3.1.1.md b/versions/3.1.1.md index 4dd173d220..3456eb787b 100644 --- a/versions/3.1.1.md +++ b/versions/3.1.1.md @@ -740,7 +740,7 @@ The path itself is still exposed to the documentation viewer but they will not k Field Name | Type | Description ---|:---:|--- -$ref | `string` | Allows for a referenced definition of this path item. The referenced structure MUST be in the form 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. See the rules for resolving [Relative References](#relativeReferencesURI). +$ref | `string` | Allows for a referenced definition of this path item. The referenced structure MUST be in the form 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. See the rules for resolving [Relative References](#relativeReferencesURI).

**Deprecated:** Usage of the `$ref` property has been deprecated when accompanied with properties other than `summary` and `description`. summary| `string` | An optional, string summary, intended to apply to all operations in this path. 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. get | [Operation Object](#operationObject) | A definition of a GET operation on this path.