callback-group-non-empty-description
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
When a description is provided for a callback group, it must contain a non-empty value. An empty description provides no useful information and should either be removed or populated with meaningful content.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Callback group description must not be empty. |
| Code | OPENAPI3APIMATIC_L524 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Callbacks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting callback group description empty |
Suggested Fixes
- Provide a meaningful description for the callback group.
- Remove the description field if no description is needed.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#callback-group-extension
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/