temporalio / temporalio/features
[Feature Request] Support reason for Cancel and Terminate workflow API
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Go
- Stars
- 32
- Forks
- 28
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 7
Description
Two problems actually, but they are related:
- Terminate allow passing a reason, which stored in the terminate event. But the Client doesn't allow retrieving this back.
- Cancel doesn't allow passing a reason at all.
It would be nice to support:
- Passing a reason/details
- Get the reason/details back when getting the workflow result(WorkflowFailure)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the workflow API paths for cancel and terminate, then trace how WorkflowFailure exposes terminate details. Confirm how workflow results are represented across the Temporal SDK compatibility tests. Done means callers can provide a reason or details for both operations and retrieve them from the resulting failure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, backend-api-design, distributed-systems
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100