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

[WORKFLOW SDK BUG] get_workflow_state fetch_payloads option default mismatch #744

Open
ajstewart opened this issue Oct 23, 2024 · 0 comments
Assignees
Labels

Comments

@ajstewart
Copy link

Expected Behavior

The docstring and option default do not match.

Obviously this is a very easy fix but I'm not sure what the intended behaviour is?

Actual Behavior

The docs say the fetch_payloads defaults to False yet it is set to True:

def get_workflow_state(
self, instance_id: str, *, fetch_payloads: bool = True
) -> Optional[WorkflowState]:
"""Fetches runtime state for the specified workflow instance.
Args:
instanceId: The unique ID of the workflow instance to fetch.
fetch_payloads: If true, fetches the input, output payloads and custom status
for the workflow instance. Defaults to false.
Returns:
The current state of the workflow instance, or None if the workflow instance does not
exist.
"""
state = self.__obj.get_orchestration_state(instance_id, fetch_payloads=fetch_payloads)
return WorkflowState(state) if state else None

Steps to Reproduce the Problem

N/A

Release Note

RELEASE NOTE:

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

No branches or pull requests

3 participants