User metadata and workflow metadata query #486
Description
Describe the solution you'd like
Users need to provide certain bits of user metadata that is visible in the UI/CLI. Specifically from a user POV we will start out with:
- Fixed "static summary" and "static details" on workflow start (includes signal with start and child workflow and scheduled workflows)
- EDIT: Late requirement - make sure these two items are available when describing a workflow and when describing a schedule of a workflow (will open issues for languages that don't have it)
- Updateable-within-workflow "current details" string
- Workflow metadata query that includes "current details" above and, if available, information about registered signals/queries/updates
- "summary" on timer start (can serve as "timer ID")
- "summary" on activity
The text format of summary/description is TBD (probably some form of mini markdown). More metadata may be added in the future.
Per-Project Tickets
- API - User metadata on workflows/events for user interface usage api#371
- Server - Attach user metadata from commands to corresponding history events temporal#5857 and User metadata not propagated from child workflow command to child workflow's execution config temporal#6412 and User metadata not propagated from schedule action to workflow's execution config temporal#6413
- Go - User metadata and workflow metadata query sdk-go#1565 and Support user metadata on activities and child/scheduled workflows sdk-go#1673
- Java - MVP support for user meta data on workflows and events sdk-java#2216 and Support workflow metadata query sdk-java#335 and Add "summary" to activities sdk-java#2268
- Core - [Feature Request] Support user metadata in child workflow, timer, and activity sdk-core#830
- TypeScript - [Feature Request] Support user metadata sdk-typescript#1544 (after Core)
- Python - [Feature Request] Support user metadata sdk-python#670 (after Core)
- .NET - [Feature Request] Support user metadata sdk-dotnet#359 (after Core)
- Ruby - [Feature Request] Support user metadata sdk-ruby#217
- PHP - [Feature Request] Support user metadata sdk-php#517 (after Go)
- Temporal CLI - [Feature Request] Support user metadata cli#690 (after Go)