non-empty-header-examples-key

Overview

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

The example name/key in header object level examples object is used to uniquely define an example value. Therefore, it should not be empty.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Empty key found for example object defined in header object.
Code	OPENAPI3DOCSGEN_L664
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 key name

Suggested Fixes

• Assign user friendly names to example object defined in header examples 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/