Asyncapi Parameter Description

asyncapi-parameter-description · built-in

Parameter objects must have "description".

Rule definition

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

asyncapi-parameter-description:
  title: Asyncapi Parameter Description
  reference: https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-parameter-description/
  description: Parameter objects must have "description".
  message: Parameter objects must have "description".
  severity: info
  given:
    - $.components.parameters.*
    - $.channels.*.parameters.*
  then:
    field: description
    function: truthy
  tags:
    - format:asyncapi
    - spec:channels
    - spec:components
    - experience:documentation
  prompt: "You are editing an AsyncAPI document to satisfy the Spotlight API
    governance rule 'asyncapi-parameter-description' (Asyncapi Parameter
    Description). Requirement: Parameter objects must have \"description\". To
    fix: Ensure `description` is present and non-empty at each matching
    location. This rule is evaluated at the JSONPath `$.components.parameters.*
    | $.channels.*.parameters.*` — 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-parameter-description' (Asyncapi Parameter Description). Requirement: Parameter objects must have "description". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.* | $.channels.*.parameters.*` — 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.