Array Items

array-items · built-in

Schemas with "type: array", require a sibling "items" field

Rule definition

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

array-items:
  title: Array Items
  reference: https://spotlight-rules.com/spec/rules/openapi/array-items/
  description: Array Items.
  message: 'Schemas with "type: array", require a sibling "items" field'
  severity: info
  given: "#ArrayProperties"
  then:
    function: truthy
    field: items
  tags:
    - format:openapi
    - spec:schemas
    - experience:data-modeling
    - experience:reliability
  prompt: "You are editing an OpenAPI document to satisfy the Spotlight API
    governance rule 'array-items' (Array Items). Requirement: Array Items. To
    fix: Ensure `items` is present and non-empty at each matching location. This
    rule is evaluated at the JSONPath `#ArrayProperties` — 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 'array-items' (Array Items). Requirement: Array Items. To fix: Ensure `items` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#ArrayProperties` — 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.