Skip to main content

header-explode-only-for-array-or-object-types

Overview

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

When the header explode is set to true, the header values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of headers this property has no effect.

PropertyValue
EnabledYes
SeverityInformation
MessageProperty explode will have no effect for header of this type.
CodeOPENAPI3STANDARDS_L131
TypeLinting
Rule SystemSemantic
Broad CategoryHeaders
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting explode header parameter array object

Suggested Fixes

  • Remove property explode from the current Header Object.
  • Change the header type to array or object if you still intend to use the explode option.

For More Information