Asyncapi Channel No Trailing Slash

asyncapi-channel-no-trailing-slash · built-in

Channel path must not end with slash.

Rule definition

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

asyncapi-channel-no-trailing-slash:
  title: Asyncapi Channel No Trailing Slash
  reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-trailing-slash/
  description: Channel path must not end with slash.
  message: Channel path must not end with slash.
  severity: info
  given: $.channels
  then:
    field: "@key"
    function: pattern
    functionOptions:
      notMatch: .+\/$
  tags:
    - format:asyncapi
    - spec:channels
    - experience:consistency
    - experience:naming
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'asyncapi-channel-no-trailing-slash' (Asyncapi Channel No
    Trailing Slash). Requirement: Channel path must not end with slash. To fix:
    Ensure `@key` does NOT match the regular expression `.+\\/$`; rename or
    rewrite any value that does. 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 'asyncapi-channel-no-trailing-slash' (Asyncapi Channel No Trailing Slash). Requirement: Channel path must not end with slash. To fix: Ensure `@key` does NOT match the regular expression `.+\/$`; rename or rewrite any value that does. 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.