Skip to main content

no-header-location-property

Overview​

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

An explicit in property must not be specified in the Header Object to indicate location since the type of object already implicitly implies it to be header.

PropertyValue
EnabledYes
Maximum SeverityError
MessageProperty in is specified in the Header Object which is not allowed.
CodeOPENAPI3STANDARDS_V246
TypeValidation
Rule SystemSemantic
Broad CategoryHeaders
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation location header

Suggested Fixes​

  • Remove the property in from the Header Object.
  • If you are referencing a global/reusable parameter using $ref, ensure that you reference a Header Object and not a Parameter Object, in order to avoid this issue.

For More Information​