required-non-empty-additional-header-name

Overview

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

A non-null, non-empty, user-friendly name must be provided for the additional header in x-additional-headers APIMatic extension.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Additional header name is missing or empty.
Code	OPENAPI3APIMATIC_L872
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Security Schemes
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting additional header empty name

Suggested Fixes

• Name of the additional header must not be null or empty.
• Assign a code-friendly and user-friendly name.
• Avoid using special characters in the name.

For More Information

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