Skip to main content

header-simple-style-only-for-array-type

Overview​

This rule belongs to the openapi-v3-standards-validation ruleset and states that:

The simple style can only be used when the type of the header is set as array i.e. it cannot be used for primitive or object types.

PropertyValue
EnabledYes
Maximum SeverityError
MessageSimple style cannot be used with the current header type.
CodeOPENAPI3STANDARDS_V248
TypeValidation
Rule SystemSemantic
Broad CategoryHeaders
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation simple style array serialization header

Suggested Fixes​

  • Ensure that the type of the header set in either the header's schema or content definition is equal to array.
  • If the header type is not expected to be an array, simply remove the style property definition.

For More Information​