payload-verification-custom-algorithm-name-required
Overview
This rule belongs to the apimatic-codegen-validation ruleset and states that:
When a custom algorithm is specified in payload verification configuration, a name field should be provided to identify the custom verifier implementation.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Payload verification is missing name field for custom algorithm. |
| Code | APIMATICCODEGEN_V525 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Webhooks |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | apimatic code generation codegen sdks portal docs validation apimatic webhook callback payload verification custom algorithm name field configuration |
Suggested Fixes
- Add a name field to specify the custom verifier implementation class or identifier.
- The name field is required only when algorithm is set to 'Custom'.
- Provide a meaningful name that identifies your custom verification implementation.
- If using built-in algorithms, the name field isn't required.