Skip to main content

multi-collection-format-only-for-form-and-query-parameter

Overview

This rule belongs to the swagger-v2-standards-validation ruleset and states that:

The value multi can only be assigned to the collectionFormat property if the parameter's location is either query or formData only.

PropertyValue
EnabledYes
Maximum SeverityError
MessageMulti collection format cannot be used with the current parameter's location.
CodeSWAGGER20STANDARDS_V111
TypeValidation
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsswagger2 swagger standards semantic validation parameter location

Suggested Fixes

  • Ensure that the value of the in property is one of the following values with no typos: query or formData.
  • Location value is compared in a case-sensitive manner.

For More Information