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

[dhiaayachi]

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.

[dhiaayachi]

Thanks for the feature request!

While we don't currently have the specific features you're requesting, we appreciate the suggestion!

In the meantime, you can use the following workaround to obtain some of the information you need:

• Operation type: You can differentiate your batch operations by using the --reason field, which allows you to specify the reason for the batch operation. This can help in identifying the type of operation being performed.
• Workflow executions: The DescribeBatchOperation API provides the Query and Executions fields, which can be used to identify the workflows affected by the batch operation.

For more information on these fields, refer to the Temporal CLI documentation.

We'll take your feature request into consideration for future updates.

[dhiaayachi]

Thanks for reporting this issue! This is a great suggestion for improving the ListBatchOperations and DescribeBatchOperation APIs.

In the meantime, you can try using the temporal batch describe --job-id command to see which workflow executions were affected by a given batch operation.

We'll consider your suggestions as we plan future enhancements to the Temporal CLI.