Document Require Description

document-require-description

description 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-description:
  title: Document Require Description
  reference: https://spotlight-rules.com/spec/rules/json-schema/document-require-description/
  description: The `description` property should be present.
  message: description should be present
  severity: info
  given: $
  then:
    field: description
    function: truthy
  tags:
    - format:jsonschema
    - spec:schemas
    - experience:documentation
    - experience:data-modeling
  prompt: "You are editing a JSON Schema document to satisfy the Spotlight API
    governance rule 'document-require-description' (Document Require
    Description). Requirement: The `description` property should be present. To
    fix: Ensure `description` 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-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` 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.