webhook-only-post-method-allowed
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Webhooks are server-initiated notifications sent to a client-specified URL. Only the POST HTTP method is allowed for webhook operations. Using any other method is not supported.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Webhook operations must only use the POST HTTP method. |
| Code | OPENAPI3APIMATIC_L1030 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Webhooks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting webhook method post operation |
Suggested Fixes
- Ensure that all webhook operations use the POST HTTP method.
- Remove or change any webhook operations that use non-POST HTTP methods.