[Feature Request] Deprecate list workflow methods?
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Go
- Stars
- 133
- Forks
- 101
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 11
Description
Is your feature request related to a problem? Please describe.
I heard we might want to deprecate some of these:
Users get surprised by the limitations of ListOpen/ListClosed (example).
Describe the solution you'd like
Mark deprecated these:
- ListOpenWorkflowExecutions
- ListClosedWorkflowExecutions
And keep these?
- ListWorkflowExecutions
- ListArchivedWorkflowExecutions (assuming you can't get archived workflows from
ListWorkflowExecutions?) - ScanWorkflowExecutions (if it's important to have an unordered option?)
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 with temporal/api/workflowservice/v1/service.proto lines 356-389 and review the definitions for ListOpenWorkflowExecutions and ListClosedWorkflowExecutions alongside the other listed methods. Determine which methods should be deprecated and whether archived workflows remain covered by ListWorkflowExecutions; done means the deprecation scope and retained methods are clearly resolved in the API definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, grpc
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100