webhook-no-group-assigned

Overview

This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:

It is recommended that webhooks are assigned to a webhook group using the APIMatic webhook group extension. Unassigned webhooks may not be properly categorized in the generated documentation or SDKs.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	No webhook group has been assigned to this webhook.
Code	OPENAPI3APIMATIC_L1033
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

Suggested Fixes

• Assign a webhook group to each webhook using the APIMatic x-webhook-group extension.
• Define webhook groups using the x-webhook-groups extension at the root level.

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/