Arazzo Document Schema

arazzo-document-schema · built-in

info experience: data-modelingexperience: reliability spec: document

Arazzo Document must be valid against the Arazzo schema.

Rule definition

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

arazzo-document-schema:
  title: Arazzo Document Schema
  reference: https://spotlight-rules.com/spec/rules/arazzo/arazzo-document-schema/
  description: Arazzo Document must be valid against the Arazzo schema.
  message: "{{error}}"
  severity: info
  given: $
  then:
    function: arazzoDocumentSchema
  tags:
    - format:arazzo
    - spec:document
    - experience:data-modeling
    - experience:reliability
  prompt: "You are editing an Arazzo document to satisfy the Spotlight API
    governance rule 'arazzo-document-schema' (Arazzo Document Schema).
    Requirement: Arazzo Document must be valid against the Arazzo schema. 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."

AI fix prompt — send this to Claude, Gemini, or ChatGPT with your artifact to auto-fix this rule

You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-document-schema' (Arazzo Document Schema). Requirement: Arazzo Document must be valid against the Arazzo schema. 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.

Artifact	Arazzo
Applies at (given)	`$`
Severity	info — educational by default; raise to `warn`/`error` to enforce
Reference	`https://spotlight-rules.com/spec/rules/arazzo/arazzo-document-schema/`

all Arazzo rules

Arazzo Info Description →