additional-header-description-exists

Overview

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

Additional header should have a non-null and non-empty description.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Description is missing from an additional header.
Code	OPENAPI3DOCSGEN_L841
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Security Schemes
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic additional headers description

Suggested Fixes

• Add a user-friendly description for the Additional Header.

For More Information

• https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#additional-headers
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/