Skip to main content

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.

PropertyValue
EnabledYes
Maximum SeverityInformation
MessageProperty explode will have no effect for the current type.
CodeOPENAPI3STANDARDS_L090
TypeLinting
Rule SystemSemantic
Broad CategoryEncoding
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 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