Document Require ID

document-require-id

$id should be present

Rule definition

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

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

You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: The `$id` property should be present. To fix: Ensure `$id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary.