Arazzo Info Summary

arazzo-info-summary · built-in

Info "summary" is recommended be present and be a non-empty string.

Rule definition

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

arazzo-info-summary:
  title: Arazzo Info Summary
  reference: https://spotlight-rules.com/spec/rules/arazzo/arazzo-info-summary/
  description: Info "summary" is recommended be present and be a non-empty string.
  message: Info "summary" is recommended be present and be a non-empty string.
  severity: info
  given: $
  then:
    field: info.summary
    function: truthy
  tags:
    - format:arazzo
    - spec:document
    - experience:documentation
  prompt: "You are editing an Arazzo document to satisfy the Spotlight API
    governance rule 'arazzo-info-summary' (Arazzo Info Summary). Requirement:
    Info \"summary\" is recommended be present and be a non-empty string. To
    fix: Ensure `info.summary` 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 Arazzo. Return only the complete corrected document, with
    no commentary."

You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-info-summary' (Arazzo Info Summary). Requirement: Info "summary" is recommended be present and be a non-empty string. To fix: Ensure `info.summary` 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 Arazzo. Return only the complete corrected document, with no commentary.