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

Overview

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

When encoding explode is true, property 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 properties the explode attribute will have no effect.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Property explode will have no effect for the current type.
Code	OPENAPI3STANDARDS_L090
Type	Linting
Rule System	Semantic
Broad Category	Encoding
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi standards semantic linting explode property array object

Suggested Fixes

• Remove property explode from the current Encoding Object.
• Change the property 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.0.3.md
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#encoding-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#encoding-object
• https://docs.apimatic.io/rulesets/overview/