Skip to main content

no-allow-empty-value-in-header

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 inside a header.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageProperty allowEmptyValue is used for a header.
CodeOPENAPI3STANDARDS_L130
TypeLinting
Rule SystemSemantic
Broad CategoryHeaders
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting empty value header

Suggested Fixes

  • Remove property allowEmptyValue from the current Header Object.

For More Information