Skip to content
Last updated

no-duplicated-enum-values

Requires all values in an enum to be unique.

OASCompatibility
2.0โœ…
3.0โœ…
3.1โœ…
3.2โœ…
AsyncAPICompatibility
2.6โœ…
3.0โœ…
ArazzoCompatibility
1.0โœ…

API design principles

A duplicated value in an enum is always a mistake: it adds noise for readers, and some tools reject such schemas because JSON Schema requires enum values to be unique. This rule catches copy-paste errors early in your API definition.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default is warn in the recommended configuration.

Example configuration:

rules:
  no-duplicated-enum-values: error

Examples

Example of incorrect enum values (duplicated value red):

schemas:
  Color:
    type: string
    enum:
      - red
      - green
      - red

Example of correct enum values (all values are unique):

schemas:
  Color:
    type: string
    enum:
      - red
      - green

Resources