Server Asyncapi Require Description

server-asyncapi-require-description

Server 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.

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