callback-payload-verification-valid-signature-value-template
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The signature value template in payload verification must follow the expected format with supported placeholders. Invalid templates will prevent proper signature extraction and verification.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The payload verification signature value template is not valid. |
| Code | OPENAPI3APIMATIC_L520 |
| 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 signature value template invalid |
Suggested Fixes
- Ensure the signature value template follows the expected format.
- Use only supported placeholders in the signature value 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/