Operation Asyncapi Require Summary

operation-asyncapi-require-summary

Operation should have a summary.

Rule definition

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

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