Skip to main content

no-header-name-property

Overview​

This rule belongs to the openapi-v3-standards-validation ruleset and states that:

An explicit name property must not be set in the Header Object since that is specified already when defining the headers map.

PropertyValue
EnabledYes
Maximum SeverityError
MessageProperty name is specified in the Header Object which is not allowed.
CodeOPENAPI3STANDARDS_V245
TypeValidation
Rule SystemSemantic
Broad CategoryHeaders
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation name header

Suggested Fixes​

  • Remove the property name from the Header Object.
  • If you are referencing a global/reusable parameter using $ref, ensure that you reference a Header Object and not a Parameter Object, in order to avoid this issue.

For More Information​