Skip to content
Developer Preview

GoalCommandResult

The shared goal ack, admission-only: all five verbs answer this one shape, differing only in when turnId is present.

  • commandId
  • status
  • turnId
Source

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

{
"description": "The shared goal ack, admission-only: all five verbs answer this\none shape, differing only in when `turnId`\nis present.",
"properties": {
"commandId": {
"description": "Echoes the client's id.",
"type": "string"
},
"status": {
"$ref": "#/$defs/CommandStatus",
"description": "Admission status."
},
"turnId": {
"description": "Present by exactly the four result cases: an idle wake carries\nthe fresh goal turn's id; a busy `set`/`edit`/`resume` carries the\nadmission-time active turn's id (a routing fact, not a delivery\npromise); `pause`/`clear` never carry it; an idle admission whose\nresulting goal is not unfinished parks the notification and carries\nnone. **Additive-optional**: absent means \"no turn named\", never\nfabricated.",
"type": "string"
}
},
"required": [
"commandId",
"status"
],
"type": "object"
}