webhook-payload-verification-invalid-algorithm
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The payload verification algorithm must be one of the supported algorithms. Invalid algorithms will prevent the webhook payload verification from being properly configured.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The specified payload verification algorithm is not valid. |
| Code | OPENAPI3APIMATIC_L1044 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Webhooks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting webhook payload verification algorithm invalid |
Suggested Fixes
- Use one of the supported payload verification algorithms.
- If a custom algorithm is needed, use the custom algorithm type and provide the algorithm name.
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/