valid-referenced-object
Overview
This rule belongs to the openapi-v3-standards-validation ruleset and states that:
If Reference Object is used for referencing a component located elsewhere, then the type of the referenced component must match with the type of the object in place of which the Reference Object is used. The referenced component must also be valid in accordance with the rules set for the type of the object that uses the Reference Object e.g. if a Reference Object is used for referencing a Parameter Object the rules that apply on the Parameter Object will apply on the referenced component.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Information |
| Message | Possible violations found in referenced object. |
| Code | OPENAPI3STANDARDS_V312 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | References |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic validation |
Suggested Fixes
- Locate the component manually and fix any issues logged against that component.
- Confirm that you are not referencing the component incorrectly.
- Confirm that you are not referencing a component of incorrect type.