at-least-one-entry-in-parameter-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 parameter, 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 | Parameter enum array is empty. |
Code | SWAGGER20STANDARDS_V119 |
Type | Validation |
Rule System | Semantic |
Broad Category | Parameters |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | swagger2 swagger standards semantic validation enum parameter 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.