Skip to main content

encoding-deep-object-style-only-for-object-type

Overview​

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

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

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

Suggested Fixes​

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

For More Information​