Asyncapi Schema

asyncapi-schema · built-in

info experience: data-modelingexperience: reliability spec: document

{{error}}

Validate structure of AsyncAPI specification.

Rule definition

The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.

asyncapi-schema:
  title: Asyncapi Schema
  reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema/
  description: Validate structure of AsyncAPI specification.
  message: "{{error}}"
  severity: info
  given: $
  then:
    function: ""
    functionOptions:
      resolved: true
  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-schema' (Asyncapi Schema). Requirement: Validate
    structure of AsyncAPI specification. 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-schema' (Asyncapi Schema). Requirement: Validate structure of AsyncAPI specification. 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.
ArtifactAsyncAPI
Applies at (given)$
Severityinfo — educational by default; raise to warn/error to enforce
Referencehttps://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema/