Skip to main content



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 and also specified in the object referenced using $ref, the Reference Object level description will override the one provided in the referenced object.

Maximum SeverityInformation
MessageDescription specified in the Reference Object overrides the description provided in the referenced object.
Rule SystemSemantic
Broad CategoryReferences
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting description reference ref $ref

Suggested Fixes

  • If you do not want the description in the referenced object to be overridden this way, remove the description property from the Reference Object.

For More Information