schema-description-exists
Overview
This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:
The Schema Object must specify details about the schema or the type of data it represents, using the description property. The value of the description must be non-null and non-empty.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Information |
| Message | Schema object description is missing. |
| Code | OPENAPI3DOCSGEN_L750 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi semantic linting apimatic description schema |
Suggested Fixes
- Ensure that the Schema Object contains the
descriptionproperty. - Ensure that Schema Object description value is not null or empty.