temporalio / temporalio/features

[Feature Request] Expose schedule specific info in Workflows through a API

Open
#243 4 comments 16 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
32
Forks
28
Avg merge
1d 9h
Merged PRs (30d)
7

Description

Is your feature request related to a problem? Please describe.

When a workflow is started by a schedule some extra information is written to search attributes

  • The TemporalScheduledStartTime Search AttributeLink preview icon is added to the Workflow Execution. The value is the Action's timestamp.
  • The TemporalScheduledById Search Attribute is added to the Workflow Execution. The value is the Schedule Id.

Currently the only way to access this info is through search attributes, this is difficult for users to discover and work with in some SDKs

Describe the solution you'd like

A separate API to return this information if the workflow was started by a schedule.

Additional context

(https://temporalio.slack.com/archives/CTDTU3J4T/p1678200766095479)

Contributor guide

No contributing guide indexed for this repository

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

No files or tests are named. Start by reviewing the existing workflow APIs and the TemporalScheduledStartTime and TemporalScheduledById search attributes described in the issue. Done means a separately discoverable API is specified and implemented to return schedule-specific information for workflows started by a schedule.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.