Skip to content

Commit 91d8c31

Browse files
committed
chore: update api spec and models
1 parent 09b6767 commit 91d8c31

File tree

2 files changed

+4
-119
lines changed

2 files changed

+4
-119
lines changed

cryosparc/api.pyi

Lines changed: 1 addition & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ from .models.scheduler_lane import SchedulerLane
7171
from .models.scheduler_target import SchedulerTarget, SchedulerTargetCluster, SchedulerTargetNode
7272
from .models.services import LoggingService
7373
from .models.session import (
74-
DataManagementStats,
7574
ExposureGroup,
7675
ExposureGroupUpdate,
7776
LiveComputeResources,
@@ -589,7 +588,7 @@ class UsersAPI(APINamespace):
589588
...
590589
def get_lanes(self, user_id: str, /) -> List[str]:
591590
"""
592-
Gets the lanes a user has access to
591+
Gets the lane names a user has access to
593592
594593
Args:
595594
user_id (str): User ID or Email Address
@@ -3586,18 +3585,6 @@ class SessionsAPI(APINamespace):
35863585
Returns:
35873586
Job: Enqueued Live Exposure Export job
35883587
3589-
"""
3590-
...
3591-
def get_data_management_stats(self, project_uid: str, /) -> Dict[str, DataManagementStats]:
3592-
"""
3593-
Gets the data management stats of all sessions in a project.
3594-
3595-
Args:
3596-
project_uid (str): Project UID, e.g., "P3"
3597-
3598-
Returns:
3599-
Dict[str, DataManagementStats]: Dictionary mapping session UIDs to data management statistics of that session
3600-
36013588
"""
36023589
...
36033590
def mark_session_completed(self, project_uid: str, session_uid: str, /) -> Session:
@@ -3611,111 +3598,6 @@ class SessionsAPI(APINamespace):
36113598
Returns:
36123599
Session: Successful Response
36133600
3614-
"""
3615-
...
3616-
def change_session_data_management_state(
3617-
self,
3618-
project_uid: str,
3619-
session_uid: str,
3620-
/,
3621-
*,
3622-
datatype: Literal["micrographs", "raw", "particles", "metadata", "thumbnails"],
3623-
status: Literal["active", "archiving", "archived", "deleted", "deleting", "missing", "calculating"],
3624-
) -> Session:
3625-
"""
3626-
Updates data management status of a session's datatype
3627-
3628-
Args:
3629-
project_uid (str): Project UID, e.g., "P3"
3630-
session_uid (str): Session UID, e.g., "S3"
3631-
datatype (Literal['micrographs', 'raw', 'particles', 'metadata', 'thumbnails']):
3632-
status (Literal['active', 'archiving', 'archived', 'deleted', 'deleting', 'missing', 'calculating']):
3633-
3634-
Returns:
3635-
Session: Successful Response
3636-
3637-
"""
3638-
...
3639-
def update_session_datatype_sizes(self, project_uid: str, session_uid: str, /) -> int:
3640-
"""
3641-
Updates the session's data_management information with the current size of each datatype.
3642-
3643-
Args:
3644-
project_uid (str): Project UID, e.g., "P3"
3645-
session_uid (str): Session UID, e.g., "S3"
3646-
3647-
Returns:
3648-
int: Size of the session's datatypes
3649-
3650-
"""
3651-
...
3652-
def get_datatype_size(
3653-
self,
3654-
project_uid: str,
3655-
session_uid: str,
3656-
datatype: Literal["micrographs", "raw", "particles", "metadata", "thumbnails"],
3657-
/,
3658-
) -> int:
3659-
"""
3660-
Gets the total size of a datatype inside a session in bytes.
3661-
3662-
Args:
3663-
project_uid (str): Project UID, e.g., "P3"
3664-
session_uid (str): Session UID, e.g., "S3"
3665-
datatype (Literal['micrographs', 'raw', 'particles', 'metadata', 'thumbnails']):
3666-
3667-
Returns:
3668-
int: Successful Response
3669-
3670-
"""
3671-
...
3672-
def delete_live_datatype(
3673-
self,
3674-
project_uid: str,
3675-
session_uid: str,
3676-
datatype: Literal["micrographs", "raw", "particles", "metadata", "thumbnails"],
3677-
/,
3678-
) -> Optional[Job]:
3679-
"""
3680-
Deletes a specific datatype inside a session.
3681-
3682-
Args:
3683-
project_uid (str): Project UID, e.g., "P3"
3684-
session_uid (str): Session UID, e.g., "S3"
3685-
datatype (Literal['micrographs', 'raw', 'particles', 'metadata', 'thumbnails']):
3686-
3687-
Returns:
3688-
Job | None: Successful Response
3689-
3690-
"""
3691-
...
3692-
def update_all_sessions_datatype_sizes(self, project_uid: str, /) -> None:
3693-
"""
3694-
Asynchronously updates the datatype sizes of all sessions within a project
3695-
3696-
Args:
3697-
project_uid (str): Project UID, e.g., "P3"
3698-
3699-
"""
3700-
...
3701-
def get_datatype_file_paths(
3702-
self,
3703-
project_uid: str,
3704-
session_uid: str,
3705-
datatype: Literal["micrographs", "raw", "particles", "metadata", "thumbnails"],
3706-
/,
3707-
) -> List[str]:
3708-
"""
3709-
Gets all the file paths associated with a specific datatype inside a session as a list
3710-
3711-
Args:
3712-
project_uid (str): Project UID, e.g., "P3"
3713-
session_uid (str): Session UID, e.g., "S3"
3714-
datatype (Literal['micrographs', 'raw', 'particles', 'metadata', 'thumbnails']):
3715-
3716-
Returns:
3717-
List[str]: Successful Response
3718-
37193601
"""
37203602
...
37213603
def get_configuration_profiles(self) -> List[SessionConfigProfile]:

cryosparc/models/user.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,6 @@ class User(BaseModel):
109109
preferences: Dict[str, Any] = {}
110110
file_browser_settings: FileBrowserPrefixes = FileBrowserPrefixes()
111111
lanes: List[str] = []
112+
"""
113+
List of lane names that a user is allowed to access
114+
"""

0 commit comments

Comments
 (0)