valid-parameter-collection-format
Overview
This rule belongs to the swagger-v2-standards-validation ruleset and states that:
The collectionFormat value determines the format of the array for parameters of type array. This must have one of the following possible values only: csv, ssv, tsv, pipes or multi only.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Invalid collectionFormat value found. |
| Code | SWAGGER20STANDARDS_V110 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Parameters |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | swagger2 swagger standards semantic validation parameter type array |
Suggested Fixes
- Ensure that the value of the
collectionFormatproperty is one of the following values with no typos:csv,ssv,tsv,pipesormulti. - The format values are compared in a case-sensitive manner.