Skip to main content

valid-header-style

Overview​

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

For headers, only the simple style is applicable and rest will be treated as invalid.

PropertyValue
EnabledYes
Maximum SeverityError
MessageThe current value of style is not applicable to headers.
CodeOPENAPI3STANDARDS_V247
TypeValidation
Rule SystemSemantic
Broad CategoryHeaders
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation style serialization header

Suggested Fixes​

  • Header style value is compared in a case-sensitive manner.
  • Ensure that you are not using a style value that is not supported for headers e.g. matrix, label, form, spaceDelimited, pipeDelimited or deepObject.
  • Ensure that the value for style is not null or empty.

For More Information​