Asyncapi Channel No Empty Parameter

asyncapi-channel-no-empty-parameter · built-in

Channel path must not have empty parameter substitution pattern.

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-empty-parameter:
  title: Asyncapi Channel No Empty Parameter
  reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-empty-parameter/
  description: Channel path must not have empty parameter substitution pattern.
  message: Channel path must not have empty parameter substitution pattern.
  severity: info
  given: $.channels
  then:
    field: "@key"
    function: pattern
    functionOptions:
      notMatch: "{}"
  tags:
    - format:asyncapi
    - spec:channels
    - experience:reliability
    - experience:consistency
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'asyncapi-channel-no-empty-parameter' (Asyncapi Channel No
    Empty Parameter). Requirement: Channel path must not have empty parameter
    substitution pattern. 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-empty-parameter' (Asyncapi Channel No Empty Parameter). Requirement: Channel path must not have empty parameter substitution pattern. 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.