Convert JobIndexSortByEnum type from Enum to Literal

galaxyproject · Mar 14, 2023 · 3a0aa25 · 3a0aa25
1 parent ca170b6
commit 3a0aa25
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 17 deletions.
diff --git a/client/src/schema/schema.ts b/client/src/schema/schema.ts
@@ -4852,12 +4852,6 @@ export interface components {
              */
             update_time: string;
         };
-        /**
-         * JobIndexSortByEnum
-         * @description An enumeration.
-         * @enum {string}
-         */
-        JobIndexSortByEnum: "create_time" | "update_time";
         /**
          * JobIndexViewEnum
          * @description An enumeration.
@@ -12024,7 +12018,7 @@ export interface operations {
                 history_id?: string;
                 workflow_id?: string;
                 invocation_id?: string;
-                order_by?: components["schemas"]["JobIndexSortByEnum"];
+                order_by?: "create_time" | "update_time";
                 search?: string;
                 limit?: number;
                 offset?: number;

diff --git a/lib/galaxy/managers/jobs.py b/lib/galaxy/managers/jobs.py
@@ -40,10 +40,7 @@
     text_column_filter,
 )
 from galaxy.model.scoped_session import galaxy_scoped_session
-from galaxy.schema.schema import (
-    JobIndexQueryPayload,
-    JobIndexSortByEnum,
-)
+from galaxy.schema.schema import JobIndexQueryPayload
 from galaxy.security.idencoding import IdEncodingHelper
 from galaxy.structured_app import StructuredApp
 from galaxy.util import (
@@ -200,7 +197,7 @@ def build_and_apply_filters(query, objects, filter_func):
                         columns.append(model.Job.job_runner_name)
                     query = query.filter(raw_text_column_filter(columns, term))
 
-        if payload.order_by == JobIndexSortByEnum.create_time:
+        if payload.order_by == "create_time":
             order_by = model.Job.create_time.desc()
         else:
             order_by = model.Job.update_time.desc()

diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py
@@ -1106,9 +1106,7 @@ class WorkflowIndexQueryPayload(Model):
     skip_step_counts: bool = False
 
 
-class JobIndexSortByEnum(str, Enum):
-    create_time = "create_time"
-    update_time = "update_time"
+JobIndexSortByEnum = Literal["create_time", "update_time"]
 
 
 class JobIndexQueryPayload(Model):
@@ -1122,7 +1120,7 @@ class JobIndexQueryPayload(Model):
     history_id: Optional[DecodedDatabaseIdField] = None
     workflow_id: Optional[DecodedDatabaseIdField] = None
     invocation_id: Optional[DecodedDatabaseIdField] = None
-    order_by: JobIndexSortByEnum = JobIndexSortByEnum.update_time
+    order_by: JobIndexSortByEnum = "update_time"
     search: Optional[str] = None
     limit: int = 500
     offset: int = 0

diff --git a/lib/galaxy/webapps/galaxy/api/jobs.py b/lib/galaxy/webapps/galaxy/api/jobs.py
@@ -141,7 +141,7 @@
 )
 
 SortByQueryParam: JobIndexSortByEnum = Query(
-    default=JobIndexSortByEnum.update_time,
+    default="update_time",
     title="Sort By",
     description="Sort results by specified field.",
 )