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.
|Message||The referenced object does not support a description, therefore, the description override provided in the Reference Object has no effect.|
|Products Impacted||API Transformer, Code Generation, Developer Experience Portal|
- Remove the
descriptionproperty from the Reference Object as it has no effect on the referenced object.