Schema Property Require Description

schema-property-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.

schema-property-require-description:
  title: Schema Property Require Description
  reference: https://spotlight-rules.com/spec/rules/json-schema/schema-property-require-description/
  description: The `description` property of each property should be present.
  message: description should be present
  severity: info
  given: $.properties[*]
  then:
    field: description
    function: truthy
  tags:
    - format:jsonschema
    - spec:properties
    - experience:documentation
    - experience:data-modeling
  prompt: "You are editing a JSON Schema document to satisfy the Spotlight API
    governance rule 'schema-property-require-description' (Schema Property
    Require Description). Requirement: The `description` property of each
    property should be present. To fix: Ensure `description` is present and
    non-empty at each matching location. This rule is evaluated at the JSONPath
    `$.properties[*]` — 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 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 'schema-property-require-description' (Schema Property Require Description). Requirement: The `description` property of each property should be present. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — 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 JSON Schema. Return only the complete corrected document, with no commentary.