Skip to main content

valid-parameter-style

Overview​

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

The property style in a Parameter Object can have only one of the following possible values: matrix, label, form, simple, spaceDelimited, pipeDelimited or deepObject. All other values will be treated as invalid.

PropertyValue
EnabledYes
Maximum SeverityError
MessageValue provided for parameter style is invalid.
CodeOPENAPI3STANDARDS_V086
TypeValidation
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation style serialization parameter

Suggested Fixes​

  • Parameter style value is compared in a case-sensitive manner.
  • Ensure that the style value matches exactly with the possible list of values and that there are no typos: matrix, label, form, simple, spaceDelimited, pipeDelimited or deepObject.
  • Ensure that the value for style is not null or empty.

For More Information​