Skip to main content

valid-encoding-style

Overview​

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

The encoding style behavior follows the same values as those allowed for query parameters, including default values. Therefore, the property style in an Encoding Object can have only one of the following possible values: form, spaceDelimited, pipeDelimited or deepObject. All other values will be treated as invalid.

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

Suggested Fixes​

  • Encoding 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: form, spaceDelimited, pipeDelimited or deepObject.
  • Ensure that the value for style is not null or empty.

For More Information​