webhook-payload-verification-digest-encoding-requires-hmac-algorithm
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The digestEncoding property in payload verification is only applicable when using HMAC-based algorithms. Using digest encoding with non-HMAC algorithms is not supported.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Digest encoding can only be used with HMAC-based payload verification algorithms. |
| Code | OPENAPI3APIMATIC_L1048 |
| 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 hmac algorithm |
Suggested Fixes
- Remove the
digestEncodingproperty if the algorithm is not HMAC-based. - Switch to an HMAC-based algorithm if digest encoding is required.
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/