Skip to main content

allow-empty-value-only-for-query-parameter

Overview

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

Property allowEmptyValue is only valid for query parameters (i.e. parameter location is set to query) and allows sending a parameter with an empty value. This property cannot be used with any other types of parameters e.g. path, header, or cookie.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageProperty allowEmptyValue is used for a non-query parameter definition.
CodeOPENAPI3STANDARDS_L062
TypeLinting
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting empty value query parameter

Suggested Fixes

  • Remove property allowEmptyValue from the current Parameter Object.
  • Change the parameter location to query if you want to allow sending it with empty values.

For More Information