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.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Property explode will have no effect for header of this type.
Code	OPENAPI3STANDARDS_L131
Type	Linting
Rule System	Semantic
Broad Category	Headers
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 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

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#header-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#header-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/