header-description-exists

Overview

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

Every header object in an OpenAPI specification must include a description property that provides a brief explanation of the header's purpose.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Header object description is missing.
Code	OPENAPI3DOCSGEN_L660
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Headers
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic description header

Suggested Fixes

• Ensure that the Header Object contains the description property.
• Ensure that Header Object description value is not null or empty.

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
• https://docs.apimatic.io/rulesets/overview/