temporalio / temporalio/features

SDK API for describing workflow

Open
#17 2 comments 0 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

Describe the solution you'd like
  • SDKs should make describing a workflow easy
  • Ideally, the response is a language-idiomatic wrapper that [at least] exposes a shortcut for status and provides access to the underlying DescribeWorkflowExecutionResponse
  • Do we want a different name other than describe?
  • Should existing SDKs w/ their own describe calls already in use still create this wrapper?

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

Review the existing SDK describe calls and the DescribeWorkflowExecutionResponse shape first. Compare how each SDK could expose a status shortcut while retaining the underlying response, and resolve whether the wrapper should be named describe and apply to SDKs with existing calls. Done means an agreed cross-SDK API design and compatibility decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
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.