Asyncapi Tags

asyncapi-tags · built-in

info experience: discoverabilityexperience: documentation spec: document

AsyncAPI object must have non-empty "tags" array.

AsyncAPI object must have non-empty “tags” array.

Rule definition

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

asyncapi-tags:
  title: Asyncapi Tags
  reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tags/
  description: AsyncAPI object must have non-empty "tags" array.
  message: AsyncAPI object must have non-empty "tags" array.
  severity: info
  given: $
  then:
    field: tags
    function: truthy
  tags:
    - format:asyncapi
    - spec:document
    - experience:discoverability
    - experience:documentation
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'asyncapi-tags' (Asyncapi Tags). Requirement: AsyncAPI
    object must have non-empty \"tags\" array. 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 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-tags' (Asyncapi Tags). Requirement: AsyncAPI object must have non-empty "tags" array. 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 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-tags/