valid-header-parameter-style

Overview

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

For header parameters, only the simple style is applicable and rest will be treated as invalid.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The current value of style is not applicable to header parameters.
Code	OPENAPI3STANDARDS_V089
Type	Validation
Rule System	Semantic
Broad Category	Parameters
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi standards semantic validation style serialization header parameter

Suggested Fixes

• Parameter style value is compared in a case-sensitive manner.
• Ensure that you are not using a style value that is not supported for header parameters e.g. matrix, label, form, spaceDelimited, pipeDelimited or deepObject.
• Ensure that the value for style is not null or empty.

For More Information

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