Document Require Required List

document-require-required-list

required 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-required-list:
  title: Document Require Required List
  reference: https://spotlight-rules.com/spec/rules/json-schema/document-require-required-list/
  description: The `required` property should be present.
  message: required should be present
  severity: info
  given: $
  then:
    field: required
    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-required-list' (Document Require Required
    List). Requirement: The `required` property should be present. To fix:
    Ensure `required` 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-required-list' (Document Require Required List). Requirement: The `required` property should be present. To fix: Ensure `required` 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.