Duplicated Entry In Enum

duplicated-entry-in-enum · built-in

{{error}}

Rule definition

The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.

duplicated-entry-in-enum:
  title: Duplicated Entry In Enum
  reference: https://spotlight-rules.com/spec/rules/openapi/duplicated-entry-in-enum/
  description: Enum values must not have duplicate entry.
  message: "{{error}}"
  severity: info
  given:
    - $..[?(@property !== 'properties' && @.enum && @.enum.constructor.name ===
      'Array')]
  then:
    field: enum
    function: oasSchema
    functionOptions:
      schema:
        type: array
        uniqueItems: true
  tags:
    - format:openapi
    - spec:schemas
    - experience:data-modeling
    - experience:consistency
  prompt: "You are editing an OpenAPI document to satisfy the Spotlight API
    governance rule 'duplicated-entry-in-enum' (Duplicated Entry In Enum).
    Requirement: Enum values must not have duplicate entry. This rule is
    evaluated at the JSONPath `$..[?(@property !== 'properties' && @.enum &&
    @.enum.constructor.name === 'Array')]` — inspect every location it matches
    and correct only what violates the rule. Make the smallest change that
    satisfies the rule, leave all unrelated content, key order, comments, and
    formatting unchanged, and keep the document valid OpenAPI. Return only the
    complete corrected document, with no commentary."

You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'duplicated-entry-in-enum' (Duplicated Entry In Enum). Requirement: Enum values must not have duplicate entry. This rule is evaluated at the JSONPath `$..[?(@property !== 'properties' && @.enum && @.enum.constructor.name === 'Array')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary.