Asyncapi Operation OperationId

asyncapi-operation-operationId · built-in

Operation must have "operationId".

Rule definition

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

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