WorkflowCancelParams

workflow/cancel params: cancel a live workflow run.

Fields and variants

• commandId
• sessionId
• workflowRunId

Source

schema/msp/experimental/msp.schema.json#/types/WorkflowCancelParams

{
  "description": "`workflow/cancel` params: cancel a live workflow run.",
  "properties": {
    "commandId": {
      "description": "The idempotency handle (UUIDv7).",
      "type": "string"
    },
    "sessionId": {
      "description": "The target session.",
      "type": "string"
    },
    "workflowRunId": {
      "description": "The run to cancel, exactly as the `workflow` item names it;\nrequired, non-empty.",
      "type": "string"
    }
  },
  "required": [
    "commandId",
    "sessionId",
    "workflowRunId"
  ],
  "type": "object"
}