callback-valid-key
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Callback keys must follow valid naming conventions so they can be reliably referenced and processed.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The callback key is not valid. |
| Code | OPENAPI3APIMATIC_L502 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Callbacks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting callback key validation |
Suggested Fixes
- Ensure that callback keys are non-empty and follow valid naming conventions.
- Avoid using special characters that may cause issues during code generation.
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/