Channel Asyncapi Require Description

channel-asyncapi-require-description

Channel should have a description.

Rule definition

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

channel-asyncapi-require-description:
  title: Channel Asyncapi Require Description
  reference: https://spotlight-rules.com/spec/rules/asyncapi/channel-asyncapi-require-description/
  description: Channels should have a description of the messages they carry.
  message: Channel should have a description.
  given: $.channels[*]
  severity: info
  then:
    field: description
    function: truthy
  tags:
    - format:asyncapi
    - spec:channels
    - experience:documentation
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'channel-asyncapi-require-description' (Channel Asyncapi
    Require Description). Requirement: Channels should have a description of the
    messages they carry. To fix: Ensure `description` is present and non-empty
    at each matching location. This rule is evaluated at the JSONPath
    `$.channels[*]` — inspect every location it matches and correct only what
    violates the rule. 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."

You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'channel-asyncapi-require-description' (Channel Asyncapi Require Description). Requirement: Channels should have a description of the messages they carry. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels[*]` — inspect every location it matches and correct only what violates the rule. 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.