Component Asyncapi Message Require Name

component-asyncapi-message-require-name

Message should declare a name.

Rule definition

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

component-asyncapi-message-require-name:
  title: Component Asyncapi Message Require Name
  reference: https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-name/
  description: Messages should declare a name.
  message: Message should declare a name.
  given: $.components.messages[*]
  severity: info
  then:
    field: name
    function: truthy
  tags:
    - format:asyncapi
    - spec:components
    - experience:documentation
    - experience:consistency
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'component-asyncapi-message-require-name' (Component
    Asyncapi Message Require Name). Requirement: Messages should declare a name.
    To fix: Ensure `name` is present and non-empty at each matching location.
    This rule is evaluated at the JSONPath `$.components.messages[*]` — 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 'component-asyncapi-message-require-name' (Component Asyncapi Message Require Name). Requirement: Messages should declare a name. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — 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.