request-body-description-exists
Overview
This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:
In an OpenAPI specification, the requestBody object defines the body of an HTTP request that an API client sends to the server. This rule ensures that the requestBody object must contain a description property that provides a clear and concise description of the request body.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Information |
| Message | RequestBody object description is missing. |
| Code | OPENAPI3DOCSGEN_L430 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Request Body |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi semantic linting apimatic description requestBody |
Suggested Fixes
- Ensure that the RequestBody Object contains the
descriptionproperty. - Ensure that the RequestBody Object description value is not null or empty.