referenced-object-allows-description-override

Overview

This rule belongs to the openapi-v3-standards-linting ruleset and states that:

If the property description is specified in the Reference Object as a sibling of property $ref, it is expected to override one specified in the referenced object provided that the referenced object supports a description. If it does not, the Reference Object level description has no effect.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	The referenced object does not support a description, therefore, the description override provided in the Reference Object has no effect.
Code	OPENAPI3STANDARDS_L144
Type	Linting
Rule System	Semantic
Broad Category	References
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi standards semantic linting description reference ref $ref

Suggested Fixes

• Remove the description property from the Reference Object as it has no effect on the referenced object.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#reference-object
• https://docs.apimatic.io/rulesets/overview/