Asyncapi 3 Document Unresolved
asyncapi-3-document-unresolved · built-in
info
experience: data-modelingexperience: reliability
spec: document
{{error}}
Checking if the AsyncAPI v3 document has valid structure before resolving references.
Rule definition
The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.
asyncapi-3-document-unresolved:
title: Asyncapi 3 Document Unresolved
reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-document-unresolved/
description: Checking if the AsyncAPI v3 document has valid structure before
resolving references.
message: "{{error}}"
severity: info
given: $
then:
function: ""
functionOptions:
resolved: false
tags:
- format:asyncapi
- spec:document
- experience:data-modeling
- experience:reliability
prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
governance rule 'asyncapi-3-document-unresolved' (Asyncapi 3 Document
Unresolved). Requirement: Checking if the AsyncAPI v3 document has valid
structure before resolving references. 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-3-document-unresolved' (Asyncapi 3 Document Unresolved). Requirement: Checking if the AsyncAPI v3 document has valid structure before resolving references. 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-3-document-unresolved/ |