callback-payload-verification-valid-message-template
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The message template in payload verification must only contain supported placeholders. Invalid placeholders will prevent the message from being properly constructed for signature verification.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The payload verification message template contains an invalid placeholder. |
| Code | OPENAPI3APIMATIC_L519 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Callbacks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting callback payload verification message template placeholder |
Suggested Fixes
- Ensure the message template contains only supported placeholders.
- Remove or replace any invalid placeholders in the message template.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#callback-group-extension
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/