Document Require Overlays

document-require-overlays

Missing `overlays`.

Rule definition

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

document-require-overlays:
  title: Document Require Overlays
  reference: https://spotlight-rules.com/spec/rules/apis-json/document-require-overlays/
  description: apis-json document should declare a `overlays` property.
  message: Missing `overlays`.
  given: $
  severity: info
  then:
    field: overlays
    function: truthy
  tags:
    - format:apis-json
    - spec:document
    - experience:governance
    - experience:discoverability
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'document-require-overlays' (Document Require Overlays).
    Requirement: apis-json document should declare a `overlays` property. To
    fix: Ensure `overlays` is present and non-empty at each matching location.
    Guidance: Missing `overlays`. Make the smallest change that satisfies the
    rule, leave all unrelated content, key order, comments, and formatting
    unchanged, and keep the document valid APIs.json. Return only the complete
    corrected document, with no commentary."

You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-overlays' (Document Require Overlays). Requirement: apis-json document should declare a `overlays` property. To fix: Ensure `overlays` is present and non-empty at each matching location. Guidance: Missing `overlays`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary.