required-response-description

Overview

This rule belongs to the swagger-v2-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.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Required property description in Response Object is missing.
Code	SWAGGER20STANDARDS_V182
Type	Validation
Rule System	Semantic
Broad Category	Responses
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	swagger2 swagger 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

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