Skip to main content

valid-response-header-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 headers of type array. This must have one of the following possible values only: csv, ssv, tsv, or pipes only.

PropertyValue
EnabledYes
Maximum SeverityError
MessageInvalid collectionFormat value found.
CodeSWAGGER20STANDARDS_V224
TypeValidation
Rule SystemSemantic
Broad CategoryResponse Headers
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsswagger2 swagger standards semantic validation header 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, or pipes.
  • The format values are compared in a case-sensitive manner.

For More Information