Skip to main content

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.

PropertyValue
EnabledYes
SeverityError
MessageHeader defined in additional/global headers is conflicting with an authentication header of the same name.
CodeAPIMATICPRE_V003
TypeValidation
Rule SystemSemantic
Broad CategoryAPI
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagspreliminary 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.