Document Require Image
document-require-image
info
experience: governanceexperience: discoverability
spec: document
Missing `image`.
apis-json document should declare a image property.
Rule definition
The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.
document-require-image:
title: Document Require Image
reference: https://spotlight-rules.com/spec/rules/apis-json/document-require-image/
description: apis-json document should declare a `image` property.
message: Missing `image`.
given: $
severity: info
then:
field: image
function: truthy
tags:
- format:apis-json
- spec:document
- experience:governance
- experience:discoverability
prompt: "You are editing an APIs.json document to satisfy the Spotlight API
governance rule 'document-require-image' (Document Require Image).
Requirement: apis-json document should declare a `image` property. To fix:
Ensure `image` is present and non-empty at each matching location. Guidance:
Missing `image`. Make the smallest change that satisfies the rule, leave all
unrelated content, key order, comments, and formatting unchanged, and keep
the document valid APIs.json. 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 APIs.json document to satisfy the Spotlight API governance rule 'document-require-image' (Document Require Image). Requirement: apis-json document should declare a `image` property. To fix: Ensure `image` is present and non-empty at each matching location. Guidance: Missing `image`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary.
| Artifact | APIs.json |
|---|---|
| Applies at (given) | $ |
| Severity | info — educational by default; raise to warn/error to enforce |
| Reference | https://spotlight-rules.com/spec/rules/apis-json/document-require-image/ |