webhook-extension-group-must-exist-when-referenced
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
When a webhook operation references a webhook group name, that group must be defined in the x-webhook-groups extension at the root level. Referencing a non-existent group will result in an invalid configuration.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The referenced webhook group does not exist in the webhook groups extension. |
| Code | OPENAPI3APIMATIC_L1051 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Webhooks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting webhook group extension reference |
Suggested Fixes
- Define the referenced webhook group in the
x-webhook-groupsextension at the root level. - Verify that the webhook group name is correctly spelled and matches the definition.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#webhook-group-extension
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/