temporalio / temporalio/temporal

Add fields to `ListBatchOperations` and `DescribeBatchOperation` API responses

Open
#4,947 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
23.2k
Forks
1.9k
Avg merge
2d 8h
Merged PRs (30d)
228

Description

Is your feature request related to a problem? Please describe.
After building pages in the Web UI to visualize Batch Operations, I observed some improvements that could be made to the ListBatchOperations and DescribeBatchOperation APIs. Specifically, when listing Batch Operations, only 4 fields are returned. This limits users in trying to differentiate their Batch Operations when listed in a tabular format, as the only uniquely identifiable field that is returned is the Job ID. Additionally, there is no way for a user to associate the Batch Operation back to a list of Workflows that were affected by the Batch Operation.

Describe the solution you'd like
I'd like to suggest that the following additions are made:

  • operation type is added to the ListBatchOperations response.
  • the visibility query (or the list of workflow executions when a batch operation was created with the executions parameter) is returned on the DescribeBatchOperation response.

Describe alternatives you've considered
N/a

Additional context
Add any other context or screenshots about the feature request here.
Currently the information we receive in the ListBatchOperations API response is quite limited and does not provide a lot of meaningful context to the user.
Screenshot 2023-10-09 at 11 31 50 AM

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the API definitions and server implementations for ListBatchOperations and DescribeBatchOperation. Trace the existing response fields and request inputs, then confirm that operation type and the visibility query or executions data are exposed as requested.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.