at-least-one-entry-in-response-header-enum-list

Overview

This rule belongs to the swagger-v2-standards-validation ruleset and states that:

If an enumeration list is declared using the enum property for the header object, it must contain at least one element which can be used for substitution i.e. the enumeration array must not be empty.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Header Object enum array is empty.
Code	SWAGGER20STANDARDS_V232
Type	Validation
Rule System	Semantic
Broad Category	Response Headers
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	swagger2 swagger standards semantic validation enum header arrays json schema validation json schema

Suggested Fixes

• Ensure that the enum array is not empty.
• If substitution options are not known beforehand or are not expected to be limited to a specific set of values, remove the enum property declaration.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#header-object
• https://datatracker.ietf.org/doc/html/draft-fge-json-schema-validation-00#section-5.5.1
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md
• https://docs.apimatic.io/rulesets/overview/