webhook-discriminator-property-pointer-points-to-valid-property
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The property pointer in the event discriminator must reference an existing property in the request body schema. If the pointer does not resolve to a valid property, the event discrimination will fail.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The event discriminator property pointer does not reference a valid property. |
| Code | OPENAPI3APIMATIC_L1040 |
| 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 valid schema |
Suggested Fixes
- Ensure the property pointer references an existing property in the request body schema.
- Verify the JSON pointer path matches the structure of the request body schema.
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/