Document Require Plan

document-require-plan

plans 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-plan:
  title: Document Require Plan
  reference: https://spotlight-rules.com/spec/rules/plans/document-require-plan/
  description: The `plans` property should be present.
  message: plans should be present
  severity: info
  given: $
  then:
    field: plans
    function: truthy
  tags:
    - format:plans
    - spec:document
    - experience:data-modeling
    - experience:governance
  prompt: "You are editing a Plans document to satisfy the Spotlight API
    governance rule 'document-require-plan' (Document Require Plan).
    Requirement: The `plans` property should be present. To fix: Ensure `plans`
    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 Plans. Return only the
    complete corrected document, with no commentary."

You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-plan' (Document Require Plan). Requirement: The `plans` property should be present. To fix: Ensure `plans` 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 Plans. Return only the complete corrected document, with no commentary.