Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDK API for describing workflow #17

Open
cretz opened this issue Feb 9, 2022 · 2 comments
Open

SDK API for describing workflow #17

cretz opened this issue Feb 9, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@cretz
Copy link
Member

cretz commented Feb 9, 2022

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?
@Sushisource
Copy link
Member

We might consider making this more generally about "wrap grpc call responses in types that expose the raw message but also provide higher-level helpers"

@cretz
Copy link
Member Author

cretz commented Feb 10, 2022

Describe is the only call I think that applies to across all SDKs atm. Granted it applies for errors and such too. But I don't think any other calls we generally wrap are complex enough to need raw protos yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants