Document Require Info
document-require-info
info
experience: governanceexperience: discoverability
spec: document
Missing `info`.
asyncapi document should declare a info 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-info:
title: Document Require Info
reference: https://spotlight-rules.com/spec/rules/asyncapi/document-require-info/
description: asyncapi document should declare a `info` property.
message: Missing `info`.
given: $
severity: info
then:
field: info
function: truthy
tags:
- format:asyncapi
- spec:document
- experience:governance
- experience:discoverability
prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
governance rule 'document-require-info' (Document Require Info).
Requirement: asyncapi document should declare a `info` property. To fix:
Ensure `info` 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
AsyncAPI. 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 AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-info' (Document Require Info). Requirement: asyncapi document should declare a `info` property. To fix: Ensure `info` 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 AsyncAPI. Return only the complete corrected document, with no commentary.| Artifact | AsyncAPI |
|---|---|
| Applies at (given) | $ |
| Severity | info — educational by default; raise to warn/error to enforce |
| Reference | https://spotlight-rules.com/spec/rules/asyncapi/document-require-info/ |