Skip to main content

required-response-description

Overview​

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.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired property description in Response Object is missing.
CodeOPENAPI3STANDARDS_V197
TypeValidation
Rule SystemSemantic
Broad CategoryResponses
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation description response

Suggested Fixes​

  • Add missing description property in the Response Object.
  • Make sure that the description property is not null or empty.

For More Information​