This rule belongs to the
openapi-v3-standards-validation ruleset and states that:
The Response Object must define a short user-friendly description of the response using the
description property. The description may provide details of what the response means, why the particular response was returned etc. e.g. if the corresponding response status is an error code, the description can provide users more details about why the error occurred.
|Message||Required property |
|Products Impacted||API Transformer, Code Generation, Developer Experience Portal|
- Add missing
descriptionproperty in the Response Object.
- Make sure that the
descriptionproperty is not null or empty.
For More Information