Asyncapi Channel Servers

asyncapi-channel-servers · built-in

info experience: reliabilityexperience: consistency spec: document

{{error}}

Channel servers must be defined in the “servers” object.

Rule definition

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

asyncapi-channel-servers:
  title: Asyncapi Channel Servers
  reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-servers/
  description: Channel servers must be defined in the "servers" object.
  message: "{{error}}"
  severity: info
  given: $
  then:
    function: asyncApi2ChannelServers
  tags:
    - format:asyncapi
    - spec:document
    - experience:reliability
    - experience:consistency
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'asyncapi-channel-servers' (Asyncapi Channel Servers).
    Requirement: Channel servers must be defined in the \"servers\" object. 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-channel-servers' (Asyncapi Channel Servers). Requirement: Channel servers must be defined in the "servers" object. 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-channel-servers/