webhook-valid-key
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Webhook keys must be non-empty and follow naming conventions. Invalid or empty webhook keys may cause issues during code generation or API documentation.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The webhook key is not valid. |
| Code | OPENAPI3APIMATIC_L1032 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Webhooks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting webhook key valid |
Suggested Fixes
- Ensure that webhook keys are non-empty and follow valid naming conventions.
- Avoid using special characters that may cause issues during code generation.