Skip to main content

encoding-pipe-delimited-style-only-for-array-or-object-types

Overview​

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

In an OpenAPI v3.1.x document, the pipeDelimited style can only be used when the type of the encoding property is set as array or object i.e. it cannot be used for primitive types.

PropertyValue
EnabledYes
Maximum SeverityError
MessagePipe delimited style cannot be used with the current property type.
CodeOPENAPI3STANDARDS_V158
TypeValidation
Rule SystemSemantic
Broad CategoryEncoding
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation pipe delimited style array object serialization property encoding

Suggested Fixes​

  • Ensure that the type of the property set in the property's schema definition is equal to array or object.
  • If the property type is not expected to be an array/object, change the value of the style property to one that supports primitive types e.g. form.
  • If the property type is not expected to be an array/object and you are unsure about which style to use, simply remove the style property definition.

For More Information​