Skip to content

Commit

Permalink
Specify valid style types for query param of workflow_dict operation
Browse files Browse the repository at this point in the history
  • Loading branch information
heisner-tillman committed Jun 4, 2024
1 parent ac37292 commit 545d6b7
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion lib/galaxy/webapps/galaxy/api/workflows.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
Any,
Dict,
List,
Literal,
Optional,
Union,
)
Expand Down Expand Up @@ -784,7 +785,9 @@ def __get_stored_workflow(self, trans, workflow_id, **kwd):
)

StyleQueryParam = Annotated[
Optional[str],
Optional[
Literal["export", "format2", "editor", "legacy", "instance", "run", "preview", "format2_wrapped_yaml", "ga"]
],
Query(
title="Style of export",
description="The default is 'export', which is meant to be used with workflow import endpoints. Other formats such as 'instance', 'editor', 'run' are tied to the GUI and should not be considered stable APIs. The default format for 'export' is specified by the admin with the `default_workflow_export_format` config option. Style can be specified as either 'ga' or 'format2' directly to be explicit about which format to download.",
Expand Down

0 comments on commit 545d6b7

Please sign in to comment.