non-conflicting-auth-and-additional-header
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
Additional or global headers apply to all endpoints of the API regardless of whether any authentication schemes apply to those endpoints or not. Therefore, a header already defined as an authentication parameter should not be added as part of additional headers as well, or vice versa.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Header defined in additional/global headers is conflicting with an authentication header of the same name. |
| Code | APIMATICPRE_V003 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | API |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic global header authentication header authentication header api |
Suggested Fixes
- Remove all conflicting headers either from the authentication parameter definitions or from the additional headers.