webhook-discriminator-property-pointer-invalid-location
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The property pointer in the event discriminator must reference a location within the request body. Pointers that reference other locations are not supported for webhook event discrimination.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The event discriminator property pointer references an invalid location. |
| Code | OPENAPI3APIMATIC_L1037 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Webhooks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting webhook discriminator property pointer location |
Suggested Fixes
- Ensure the property pointer references a location within the request body.
- Only request body locations are supported for webhook event discrimination.
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/