path-item-field-either-in-referenced-or-defined-object
Overview
This rule belongs to the openapi-v3-standards-linting ruleset and states that:
In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Information |
| Message | Path item field exists in both the referenced and defined objects. |
| Code | OPENAPI3STANDARDS_L030 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Path Items |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic linting path item path reference json pointer ref $ref |
Suggested Fixes
- Remove any other properties from the reference Path Item Object (i.e. one that contains the $ref property) and relocate them in the defined object instead.