webhook-discriminator-property-pointer-invalid-format
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The property pointer in the event discriminator must follow a valid JSON pointer format starting with /. An invalid format will prevent the discriminator from correctly identifying the event type field.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The event discriminator property pointer has an invalid format. |
| Code | OPENAPI3APIMATIC_L1036 |
| 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 format |
Suggested Fixes
- Ensure the property pointer follows a valid JSON pointer format starting with
/. - Example of a valid property pointer:
/body#/eventType.
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/