valid-items-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 items of type array
. This must have one of the following possible values only: csv
, ssv
, tsv
, or pipes
only.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Invalid collectionFormat value found. |
Code | SWAGGER20STANDARDS_V153 |
Type | Validation |
Rule System | Semantic |
Broad Category | Array Items |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | swagger2 swagger standards semantic validation items object type array |
Suggested Fixes
- Ensure that the value of the
collectionFormat
property is one of the following values with no typos:csv
,ssv
,tsv
, orpipes
. - The format values are compared in a case-sensitive manner.