no-allow-reserved-in-header

Overview

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

Property allowReserved is only valid for query parameters (i.e. parameter location is set to query) and allows sending a parameter with reserved characters. This property cannot be used inside a header.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Property allowReserved is used for a header.
Code	OPENAPI3STANDARDS_L132
Type	Linting
Rule System	Semantic
Broad Category	Headers
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi standards semantic linting reserved header

Suggested Fixes

• Remove property allowReserved from the current Header Object.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#header-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#header-object
• https://docs.apimatic.io/rulesets/overview/