fix(events): correct generated models with const types (#147)

nfrasser · web-flow · commit ddbf2bdf1527 · 2025-09-26T16:17:00.000-04:00
that is, values that are Literals and Enums with a single item
diff --git a/cryosparc/api.pyi b/cryosparc/api.pyi
@@ -299,12 +299,12 @@ class InstanceAPI(APINamespace):
 
         """
         ...
-    def audit_dump(self, *, timestamp: Union[float, str, None] = None) -> Optional[str]:
+    def audit_dump(self, *, timestamp: Union[float, Literal["auto"], None] = None) -> Optional[str]:
         """
         Generate an audit dump file containing all audit logs since the given timestamp.
 
         Args:
-            timestamp (float | str, optional): Leave unspecified to dump all audit logs, set to "auto" to dump new logs since the last dump, or set to a UNIX timestamp to dump every log that occurred after it.. Defaults to None
+            timestamp (float | Literal['auto'], optional): Leave unspecified to dump all audit logs, set to "auto" to dump new logs since the last dump, or set to a UNIX timestamp to dump every log that occurred after it.. Defaults to None
 
         Returns:
             str | None: Successful Response
@@ -1385,7 +1385,7 @@ class JobsAPI(APINamespace):
         input_name: str,
         /,
         *,
-        force_join: Union[bool, str] = "auto",
+        force_join: Union[bool, Literal["auto"]] = "auto",
         slots: Union[Literal["default", "passthrough", "all"], List[str]] = "default",
     ) -> Dataset:
         """
@@ -1395,7 +1395,7 @@ class JobsAPI(APINamespace):
             project_uid (str): Project UID, e.g., "P3"
             job_uid (str): Job UID, e.g., "J3"
             input_name (str):
-            force_join (bool | str, optional): Defaults to 'auto'
+            force_join (bool | Literal['auto'], optional): Defaults to 'auto'
             slots (Literal['default', 'passthrough', 'all'] | List[str], optional): Defaults to 'default'
 
         Returns:
@@ -1410,7 +1410,7 @@ class JobsAPI(APINamespace):
         output_name: str,
         /,
         *,
-        version: Union[int, str] = "F",
+        version: Union[int, Literal["F"]] = "F",
         slots: Union[Literal["default", "passthrough", "all"], List[str]] = "default",
     ) -> Dataset:
         """
@@ -1420,7 +1420,7 @@ class JobsAPI(APINamespace):
             project_uid (str): Project UID, e.g., "P3"
             job_uid (str): Job UID, e.g., "J3"
             output_name (str):
-            version (int | str, optional): Set to F (default) to load the final version. Defaults to 'F'
+            version (int | Literal['F'], optional): Set to F (default) to load the final version. Defaults to 'F'
             slots (Literal['default', 'passthrough', 'all'] | List[str], optional): Defaults to 'default'
 
         Returns:
@@ -1578,7 +1578,7 @@ class JobsAPI(APINamespace):
         source_job_uid: str,
         source_output_name: str,
         source_result_name: str,
-        source_result_version: Union[int, str] = "F",
+        source_result_version: Union[int, Literal["F"]] = "F",
     ) -> Job:
         """
         Adds or replaces a result within an input connection with the given output result from a different job.
@@ -1592,7 +1592,7 @@ class JobsAPI(APINamespace):
             source_job_uid (str):
             source_output_name (str):
             source_result_name (str):
-            source_result_version (int | str, optional): Defaults to 'F'
+            source_result_version (int | Literal['F'], optional): Defaults to 'F'
 
         Returns:
             Job: Successful Response
@@ -1733,7 +1733,14 @@ class JobsAPI(APINamespace):
         """
         ...
     def get_output_result_path(
-        self, project_uid: str, job_uid: str, output_name: str, result_name: str, /, *, version: Union[int, str] = "F"
+        self,
+        project_uid: str,
+        job_uid: str,
+        output_name: str,
+        result_name: str,
+        /,
+        *,
+        version: Union[int, Literal["F"]] = "F",
     ) -> str:
         """
         Get the absolute path for a job output's dataset or volume density.
@@ -1743,7 +1750,7 @@ class JobsAPI(APINamespace):
             job_uid (str): Job UID, e.g., "J3"
             output_name (str):
             result_name (str):
-            version (int | str, optional): Defaults to 'F'
+            version (int | Literal['F'], optional): Defaults to 'F'
 
         Returns:
             str: Successful Response
@@ -1830,7 +1837,7 @@ class JobsAPI(APINamespace):
         ...
     def get_event_logs(
         self, project_uid: str, job_uid: str, /, *, checkpoint: Optional[int] = None
-    ) -> List[Union[Event, CheckpointEvent, TextEvent, ImageEvent, InteractiveEvent]]:
+    ) -> List[Union[TextEvent, ImageEvent, InteractiveEvent, CheckpointEvent, Event]]:
         """
         Gets all event logs for a job.
 
@@ -1842,7 +1849,7 @@ class JobsAPI(APINamespace):
             checkpoint (int, optional): Defaults to None
 
         Returns:
-            List[Union[Event, CheckpointEvent, TextEvent, ImageEvent, InteractiveEvent]]: Successful Response
+            List[Union[TextEvent, ImageEvent, InteractiveEvent, CheckpointEvent, Event]]: Successful Response
 
         """
         ...
diff --git a/cryosparc/models/asset.py b/cryosparc/models/asset.py
@@ -25,7 +25,7 @@ class GridFSFile(BaseModel):
     contentType: Union[
         Literal["text/plain", "text/csv", "text/html", "application/json", "application/xml", "application/x-troff"],
         Literal["application/pdf", "image/gif", "image/jpeg", "image/png", "image/svg+xml"],
-        str,
+        Literal["application/octet-stream"],
     ]
     """
     Asset content type, e.g., "image/png"
diff --git a/cryosparc/models/auth.py b/cryosparc/models/auth.py
@@ -1,8 +1,10 @@
 # THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
 # SEE dev/api_generate_models.py
+from typing import Literal
+
 from pydantic import BaseModel
 
 
 class Token(BaseModel):
     access_token: str
-    token_type: str
+    token_type: Literal["bearer"]
diff --git a/cryosparc/models/event.py b/cryosparc/models/event.py
@@ -25,7 +25,7 @@ class CheckpointEvent(BaseModel):
     avail_mb: Optional[float] = None
     flags: List[str] = []
     meta: Dict[str, Any] = {}
-    type: str
+    type: Literal["checkpoint"]
 
 
 class Event(BaseModel):
@@ -64,7 +64,7 @@ class ImageEvent(BaseModel):
     avail_mb: Optional[float] = None
     flags: List[str] = []
     meta: Dict[str, Any] = {}
-    type: str
+    type: Literal["image"]
     text: str
     imgfiles: List[GridFSAsset] = []
 
@@ -97,7 +97,7 @@ class InteractiveEvent(BaseModel):
     avail_mb: Optional[float] = None
     flags: List[str] = []
     meta: Dict[str, Any] = {}
-    type: str
+    type: Literal["interactive"]
     subtype: str = "3dscatter"
     text: str
     datafile: InteractiveGridFSAsset
diff --git a/cryosparc/models/job_spec.py b/cryosparc/models/job_spec.py
@@ -68,7 +68,7 @@ class InputResult(BaseModel):
     Name of output result slot in parent job, e.g., "blob". Usually the same
     as "name" but may differ if there are multiple outputs of the same type
     """
-    version: Union[int, str] = "F"
+    version: Union[int, Literal["F"]] = "F"
     """
     Version number or specifier to use. Usually "F"
     """
@@ -232,7 +232,7 @@ class Input(BaseModel):
     """
     Minimum number of connections to this input.
     """
-    count_max: Union[int, str] = "inf"
+    count_max: Union[int, Literal["inf"]] = "inf"
     """
     Maximum number of connections for this input.
     Should be any integer >= 0 or ``"inf"`` (for infinity)
@@ -293,7 +293,7 @@ class InputSpec(BaseModel):
     """
     Minimum number of connections to this input.
     """
-    count_max: Union[int, str] = "inf"
+    count_max: Union[int, Literal["inf"]] = "inf"
     """
     Maximum number of connections for this input.
     Should be any integer >= 0 or ``"inf"`` (for infinity)
diff --git a/cryosparc/models/scheduler_target.py b/cryosparc/models/scheduler_target.py
@@ -1,6 +1,6 @@
 # THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
 # SEE dev/api_generate_models.py
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Literal, Optional, Union
 
 from pydantic import BaseModel
 
@@ -13,7 +13,7 @@ class Node(BaseModel):
     Node-type scheduler target that may include GPUs
     """
 
-    type: str
+    type: Literal["node"]
     """
     Node scheduler targets have type "node".
     """
@@ -61,7 +61,7 @@ class Cluster(BaseModel):
     """
     Template command to check cluster queue info.
     """
-    type: str
+    type: Literal["cluster"]
     """
     Cluster scheduler targets have type "cluster".
     """
diff --git a/cryosparc/models/session.py b/cryosparc/models/session.py
@@ -13,7 +13,7 @@
 
 
 class AthenaVolumeUploadParams(BaseModel):
-    type: str = "refinement"
+    type: Literal["refinement"] = "refinement"
     name: str
     path_rel: str
     symmetry: str = "C1"
@@ -245,7 +245,7 @@ class Session(BaseModel):
     """
     uid: str
     project_uid: str
-    workspace_type: str = "live"
+    workspace_type: Literal["live"] = "live"
     created_by_user_id: Optional[str] = None
     title: Optional[str] = None
     description: Optional[str] = None
diff --git a/cryosparc/models/user.py b/cryosparc/models/user.py
@@ -99,7 +99,7 @@ class User(BaseModel):
     name: str
     first_name: str
     last_name: str
-    status: str = "invited"
+    status: Literal["invited"] = "invited"
     profile: Profile = Profile()
     roles: Dict[str, List[Literal["user", "admin"]]] = {}
     register_token: Optional[str] = None

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class GridFSFile(BaseModel):`
`25`	`25`	`contentType: Union[`
`26`	`26`	`Literal["text/plain", "text/csv", "text/html", "application/json", "application/xml", "application/x-troff"],`
`27`	`27`	`Literal["application/pdf", "image/gif", "image/jpeg", "image/png", "image/svg+xml"],`
`28`		`- str,`
	`28`	`+ Literal["application/octet-stream"],`
`29`	`29`	`]`
`30`	`30`	`"""`
`31`	`31`	`Asset content type, e.g., "image/png"`