Asyncapi Info Description
asyncapi-info-description · built-in
info
experience: documentation
spec: document
Info "description" must be present and non-empty string.
Info “description” must be present and 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.
asyncapi-info-description:
title: Asyncapi Info Description
reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-description/
description: Info "description" must be present and non-empty string.
message: Info "description" must be present and non-empty string.
severity: info
given: $
then:
field: info.description
function: truthy
tags:
- format:asyncapi
- spec:document
- experience:documentation
prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
governance rule 'asyncapi-info-description' (Asyncapi Info Description).
Requirement: Info \"description\" must be present and non-empty string. To
fix: Ensure `info.description` 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 'asyncapi-info-description' (Asyncapi Info Description). Requirement: Info "description" must be present and non-empty string. To fix: Ensure `info.description` 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/asyncapi-info-description/ |