Document Require Tag
document-require-tag
info
experience: governanceexperience: discoverability
spec: document
Missing `tags`.
apis-json document should declare a tags 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-tag:
title: Document Require Tag
reference: https://spotlight-rules.com/spec/rules/apis-json/document-require-tag/
description: apis-json document should declare a `tags` property.
message: Missing `tags`.
given: $
severity: info
then:
field: tags
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-tag' (Document Require Tag). Requirement:
apis-json document should declare a `tags` property. To fix: Ensure `tags`
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 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-tag' (Document Require Tag). Requirement: apis-json document should declare a `tags` property. To fix: Ensure `tags` 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 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-tag/ |