chore: update models and api spec

Author: nfrasser

cryosparc/api.pyi

@@ -17,6 +17,7 @@ from .models.api_response import (
 )
 from .models.asset import GridFSAsset, GridFSFile
 from .models.auth import Token
+from .models.config import SystemInfo
 from .models.diagnostics import RuntimeDiagnostics
 from .models.event import CheckpointEvent, Event, ImageEvent, InteractiveEvent, TextEvent
 from .models.exposure import Exposure
@@ -29,7 +30,7 @@ from .models.notification import Notification
 from .models.project import GenerateIntermediateResultsSettings, Project, ProjectSymlink
 from .models.scheduler_lane import SchedulerLane
 from .models.scheduler_target import Cluster, Node, SchedulerTarget
-from .models.service import LoggingService, ServiceLogLevel
+from .models.services import LoggingService
 from .models.session import (
     DataManagementStats,
     ExposureGroup,
@@ -56,8 +57,14 @@ class APINamespace:
 
 class ConfigNamespace(APINamespace):
     """
-    Methods available in api.config, e.g., api.config.get_instance_uid(...)
+    Methods available in api.config, e.g., api.config.set_instance_banner(...)
     """
+    def set_instance_banner(
+        self, *, active: bool = False, title: Optional[str] = ..., body: Optional[str] = ...
+    ) -> Any: ...
+    def set_login_message(
+        self, *, active: bool = False, title: Optional[str] = ..., body: Optional[str] = ...
+    ) -> Any: ...
     def get_instance_uid(self) -> str:
         """
         Gets this CryoSPARC instance's unique UID.
@@ -80,7 +87,7 @@ class ConfigNamespace(APINamespace):
         Gets the current CryoSPARC version (with patch suffix, if available)
         """
         ...
-    def get_system_info(self) -> Dict[str, Any]:
+    def get_system_info(self) -> SystemInfo:
         """
         System information related to the CryoSPARC application
         """
@@ -140,16 +147,7 @@ class InstanceNamespace(APINamespace):
         """
         ...
     def get_service_log(
-        self,
-        service: LoggingService,
-        /,
-        *,
-        days: int = 7,
-        date: Optional[str] = ...,
-        log_name: str = "",
-        func_name: str = "",
-        level: Optional[ServiceLogLevel] = ...,
-        max_lines: Optional[int] = ...,
+        self, service: LoggingService, /, *, days: int = 30, date: Optional[str] = ..., max_lines: Optional[int] = ...
     ) -> str:
         """
         Gets cryosparc service logs, filterable by date, name, function, and level
@@ -160,6 +158,7 @@ class InstanceNamespace(APINamespace):
         Gets runtime diagnostics for the CryoSPARC instance
         """
         ...
+    def audit_dump(self) -> str | None: ...
 
 class CacheNamespace(APINamespace):
     """
@@ -797,7 +796,7 @@ class JobsNamespace(APINamespace):
         Adds the job to the queue for the given worker lane (default lane if not specified)
         """
         ...
-    def recalculate_intermediate_results_size(self, project_uid: str, job_uid: str, /) -> Any:
+    def recalculate_size_async(self, project_uid: str, job_uid: str, /) -> Any:
         """
         For a job, find intermediate results and recalculate their total size.
         """
@@ -2337,7 +2336,7 @@ class DeveloperNamespace(APINamespace):
 class APIClient:
     """
     Top-level API client class. e.g., ``api.read_root(...)``
-    or ``api.config.get_instance_uid(...)``
+    or ``api.config.set_instance_banner(...)``
     """
 
     config: ConfigNamespace

cryosparc/model_registry.py

@@ -5,6 +5,7 @@
     api_response,
     asset,
     auth,
+    config,
     diagnostics,
     event,
     exposure,
@@ -20,7 +21,7 @@
     project,
     scheduler_lane,
     scheduler_target,
-    service,
+    services,
     session,
     session_config_profile,
     session_params,
@@ -54,11 +55,12 @@
 register_model_module(when)
 register_model_module(params)
 register_model_module(license)
-register_model_module(service)
+register_model_module(services)
 register_model_module(notification)
 register_model_module(diagnostics)
 register_model_module(scheduler_lane)
 register_model_module(session_spec)
 register_model_module(session_config_profile)
+register_model_module(config)
 register_model_module(tag)
 register_model_module(auth)

cryosparc/models/config.py

@@ -0,0 +1,14 @@
+# THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
+# SEE dev/api_generate_models.py
+from pydantic import BaseModel
+
+
+class SystemInfo(BaseModel):
+    version: str
+    master_hostname: str
+    port_app: int
+    port_mongo: int
+    port_api: int
+    port_command_vis: int
+    port_rtp_webapp: int
+    is_db_auth_enabled: bool

cryosparc/models/services.py

@@ -0,0 +1,8 @@
+# THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
+# SEE dev/api_generate_models.py
+from typing import Literal
+
+LoggingService = Literal["app", "database", "cache", "api", "scheduler", "command_vis", "app_api", "supervisord"]
+"""
+Same as Service, but also includes supervisord.
+"""

cryosparc/models/session_params.py

@@ -1,8 +1,8 @@
 # THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
 # SEE dev/api_generate_models.py
-from typing import Literal, Optional
+from typing import TYPE_CHECKING, Any, Literal, Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 
 class LivePreprocessingParams(BaseModel):
@@ -75,12 +75,24 @@ class LivePreprocessingParams(BaseModel):
     extract_f16: bool = False
     do_plotting: bool = False
 
+    model_config = ConfigDict(extra="allow")
+    if TYPE_CHECKING:
+
+        def __init__(self, **kwargs: Any) -> None: ...
+        def __getattr__(self, key: str) -> Any: ...
+
 
 class LiveAbinitParams(BaseModel):
     abinit_symmetry: str = "C1"
     abinit_K: int = 1
     abinit_num_particles: Optional[int] = None
 
+    model_config = ConfigDict(extra="allow")
+    if TYPE_CHECKING:
+
+        def __init__(self, **kwargs: Any) -> None: ...
+        def __getattr__(self, key: str) -> Any: ...
+
 
 class LiveClass2DParams(BaseModel):
     class2D_K: int = 50
@@ -89,7 +101,19 @@ class LiveClass2DParams(BaseModel):
     compute_use_ssd: bool = True
     psize_mic: Optional[float] = None
 
+    model_config = ConfigDict(extra="allow")
+    if TYPE_CHECKING:
+
+        def __init__(self, **kwargs: Any) -> None: ...
+        def __getattr__(self, key: str) -> Any: ...
+
 
 class LiveRefineParams(BaseModel):
     refine_symmetry: str = "C1"
     psize_mic: Optional[float] = None
+
+    model_config = ConfigDict(extra="allow")
+    if TYPE_CHECKING:
+
+        def __init__(self, **kwargs: Any) -> None: ...
+        def __getattr__(self, key: str) -> Any: ...

cryosparc/models/user.py

@@ -85,7 +85,7 @@ class User(BaseModel):
     id: str = Field("000000000000000000000000", alias="_id")
     updated_at: datetime.datetime = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
     created_at: datetime.datetime = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
-    emails: List[Email]
+    emails: List[Email] = []
     created_by_user_id: Optional[str] = None
     name: str
     first_name: str