Skip to content

Commit 0190929

Browse files
authored
Merge pull request #508 from Smeds/patch-1
add parameters to show_workflow
2 parents 8fd40ff + a598718 commit 0190929

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

bioblend/galaxy/workflows/__init__.py

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,13 @@ def get_workflows(
6565
workflows = [_ for _ in workflows if _["name"] == name]
6666
return workflows
6767

68-
def show_workflow(self, workflow_id: str, version: Optional[int] = None) -> dict[str, Any]:
68+
def show_workflow(
69+
self,
70+
workflow_id: str,
71+
version: Optional[int] = None,
72+
instance: Optional[bool] = None,
73+
legacy: Optional[bool] = None,
74+
) -> dict[str, Any]:
6975
"""
7076
Display information needed to run a workflow.
7177
@@ -75,6 +81,16 @@ def show_workflow(self, workflow_id: str, version: Optional[int] = None) -> dict
7581
:type version: int
7682
:param version: Workflow version to show
7783
84+
:type instance: bool
85+
:param instance: treat ``workflow_id`` as a Workflow ID if True,
86+
otherwise treat it as a StoredWorkflow ID (the default). This
87+
parameter works only on Galaxy 20.01 or later.
88+
89+
:type legacy: bool
90+
:param legacy: whether to use the legacy workflow format (default is
91+
False). Before Galaxy 24.0, passing False to this parameter was
92+
mistakenly equivalent to passing True.
93+
7894
:rtype: dict
7995
:return: A description of the workflow and its inputs.
8096
For example::
@@ -85,8 +101,13 @@ def show_workflow(self, workflow_id: str, version: Optional[int] = None) -> dict
85101
'url': '/api/workflows/92c56938c2f9b315'}
86102
"""
87103
params: dict[str, Any] = {}
104+
88105
if version is not None:
89106
params["version"] = version
107+
if instance is not None:
108+
params["instance"] = instance
109+
if legacy is not None:
110+
params["legacy"] = legacy
90111

91112
return self._get(id=workflow_id, params=params)
92113

0 commit comments

Comments
 (0)