parameter-explode-only-for-array-or-object-types
Overview
This rule belongs to the openapi-v3-standards-linting ruleset and states that:
When parameter explode is true, parameter 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 parameters this property has no effect.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Information |
| Message | Property explode will have no effect on parameter of this type. |
| Code | OPENAPI3STANDARDS_L063 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Parameters |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic linting explode parameter array object |
Suggested Fixes
- Remove property
explodefrom the current Parameter Object. - Change the parameter type to
arrayorobjectif you still intend to use theexplodeoption.