valid-header-example

Overview

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

Example value provided for the header object should conform to the header schema.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Invalid header example found.
Code	OPENAPI3DOCSGEN_L662
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Headers
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic header example examples schema

Suggested Fixes

• Provide valid example value for header object.
• Exmaple value should conform to the schema defined in header object.

For More Information

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