webhook-payload-verification-valid-digest-encoding
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The payload verification digest encoding must be one of the supported encoding formats. Invalid encoding values will prevent proper payload verification configuration.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The specified payload verification digest encoding is not valid. |
| Code | OPENAPI3APIMATIC_L1047 |
| 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 digest encoding invalid |
Suggested Fixes
- Use one of the supported digest encoding formats for payload verification.
- Verify the encoding value matches a supported format.
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/