Skip to main content

no-allow-empty-value-for-deep-object-style-parameter

Overview​

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

Empty valued parameters cannot be serialized when using the deepObject style type. Therefore, for such cases, the value of allowEmptyValue will be ignored.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageValue of allowEmptyValue will be ignored for deepObject parameter style.
CodeOPENAPI3STANDARDS_V098
TypeValidation
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation style deep object serialization parameter allow empty value

Suggested Fixes​

  • Remove the allowEmptyValue flag from the parameter definition if you are using the deepObject style.
  • Change the value of the parameter style from simple to one that supports empty values e.g. matrix, label, form.

For More Information​