callback-no-group-assigned-warning
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
It is recommended that callbacks are assigned to a callback group using the APIMatic callback group extension. Unassigned callbacks may not be properly categorized in the generated documentation or SDKs.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | No callback group has been assigned to this callback. |
| Code | OPENAPI3APIMATIC_L503 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Callbacks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting callback group extension |
Suggested Fixes
- Assign a callback group to each callback using the APIMatic
x-callback-groupextension. - Define callback groups using the
x-callback-groupsextension at the root level.
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/