zenml-nightly 0.75.0.dev20250313__py3-none-any.whl → 0.75.0.dev20250315__py3-none-any.whl

zenml/zen_server/routers/{workspaces_endpoints.py → projects_endpoints.py}

@@ -11,7 +11,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 #  or implied. See the License for the specific language governing
 #  permissions and limitations under the License.
-"""Endpoint definitions for workspaces."""
+"""Endpoint definitions for projects."""
 
 from typing import Union
 from uuid import UUID
@@ -20,6 +20,7 @@ from fastapi import APIRouter, Depends, Security
 
 from zenml.constants import (
     API,
+    PROJECTS,
     STATISTICS,
     VERSION_1,
     WORKSPACES,
@@ -28,11 +29,11 @@ from zenml.models import (
     Page,
     PipelineFilter,
     PipelineRunFilter,
-    WorkspaceFilter,
-    WorkspaceRequest,
-    WorkspaceResponse,
-    WorkspaceStatistics,
-    WorkspaceUpdate,
+    ProjectFilter,
+    ProjectRequest,
+    ProjectResponse,
+    ProjectStatistics,
+    ProjectUpdate,
 )
 from zenml.zen_server.auth import AuthContext, authorize
 from zenml.zen_server.exceptions import error_response
@@ -53,188 +54,230 @@ from zenml.zen_server.utils import (
     zen_store,
 )
 
-router = APIRouter(
+workspace_router = APIRouter(
     prefix=API + VERSION_1 + WORKSPACES,
     tags=["workspaces"],
     responses={401: error_response},
 )
 
+router = APIRouter(
+    prefix=API + VERSION_1 + PROJECTS,
+    tags=["projects"],
+    responses={401: error_response},
+)
+
 
+# TODO: kept for backwards compatibility only; to be removed after the migration
+@workspace_router.get(
+    "",
+    responses={401: error_response, 404: error_response, 422: error_response},
+    deprecated=True,
+)
 @router.get(
     "",
     responses={401: error_response, 404: error_response, 422: error_response},
 )
 @handle_exceptions
-def list_workspaces(
-    workspace_filter_model: WorkspaceFilter = Depends(
-        make_dependable(WorkspaceFilter)
+def list_projects(
+    project_filter_model: ProjectFilter = Depends(
+        make_dependable(ProjectFilter)
     ),
     hydrate: bool = False,
     _: AuthContext = Security(authorize),
-) -> Page[WorkspaceResponse]:
-    """Lists all workspaces in the organization.
+) -> Page[ProjectResponse]:
+    """Lists all projects in the organization.
 
     Args:
-        workspace_filter_model: Filter model used for pagination, sorting,
+        project_filter_model: Filter model used for pagination, sorting,
             filtering,
         hydrate: Flag deciding whether to hydrate the output model(s)
             by including metadata fields in the response.
 
     Returns:
-        A list of workspaces.
+        A list of projects.
     """
     return verify_permissions_and_list_entities(
-        filter_model=workspace_filter_model,
-        resource_type=ResourceType.WORKSPACE,
-        list_method=zen_store().list_workspaces,
+        filter_model=project_filter_model,
+        resource_type=ResourceType.PROJECT,
+        list_method=zen_store().list_projects,
         hydrate=hydrate,
     )
 
 
+# TODO: kept for backwards compatibility only; to be removed after the migration
+@workspace_router.post(
+    "",
+    responses={401: error_response, 409: error_response, 422: error_response},
+    deprecated=True,
+)
 @router.post(
     "",
     responses={401: error_response, 409: error_response, 422: error_response},
 )
 @handle_exceptions
-def create_workspace(
-    workspace_request: WorkspaceRequest,
+def create_project(
+    project_request: ProjectRequest,
     _: AuthContext = Security(authorize),
-) -> WorkspaceResponse:
-    """Creates a workspace based on the requestBody.
+) -> ProjectResponse:
+    """Creates a project based on the requestBody.
 
     # noqa: DAR401
 
     Args:
-        workspace_request: Workspace to create.
+        project_request: Project to create.
 
     Returns:
-        The created workspace.
+        The created project.
     """
     return verify_permissions_and_create_entity(
-        request_model=workspace_request,
-        create_method=zen_store().create_workspace,
+        request_model=project_request,
+        create_method=zen_store().create_project,
     )
 
 
+# TODO: kept for backwards compatibility only; to be removed after the migration
+@workspace_router.get(
+    "/{project_name_or_id}",
+    responses={401: error_response, 404: error_response, 422: error_response},
+    deprecated=True,
+)
 @router.get(
-    "/{workspace_name_or_id}",
+    "/{project_name_or_id}",
     responses={401: error_response, 404: error_response, 422: error_response},
 )
 @handle_exceptions
-def get_workspace(
-    workspace_name_or_id: Union[str, UUID],
+def get_project(
+    project_name_or_id: Union[str, UUID],
     hydrate: bool = True,
     _: AuthContext = Security(authorize),
-) -> WorkspaceResponse:
-    """Get a workspace for given name.
+) -> ProjectResponse:
+    """Get a project for given name.
 
     # noqa: DAR401
 
     Args:
-        workspace_name_or_id: Name or ID of the workspace.
+        project_name_or_id: Name or ID of the project.
         hydrate: Flag deciding whether to hydrate the output model(s)
             by including metadata fields in the response.
 
     Returns:
-        The requested workspace.
+        The requested project.
     """
     return verify_permissions_and_get_entity(
-        id=workspace_name_or_id,
-        get_method=zen_store().get_workspace,
+        id=project_name_or_id,
+        get_method=zen_store().get_project,
         hydrate=hydrate,
     )
 
 
+# TODO: kept for backwards compatibility only; to be removed after the migration
+@workspace_router.put(
+    "/{project_name_or_id}",
+    responses={401: error_response, 404: error_response, 422: error_response},
+    deprecated=True,
+)
 @router.put(
-    "/{workspace_name_or_id}",
+    "/{project_name_or_id}",
     responses={401: error_response, 404: error_response, 422: error_response},
 )
 @handle_exceptions
-def update_workspace(
-    workspace_name_or_id: UUID,
-    workspace_update: WorkspaceUpdate,
+def update_project(
+    project_name_or_id: UUID,
+    project_update: ProjectUpdate,
     _: AuthContext = Security(authorize),
-) -> WorkspaceResponse:
-    """Get a workspace for given name.
+) -> ProjectResponse:
+    """Get a project for given name.
 
     # noqa: DAR401
 
     Args:
-        workspace_name_or_id: Name or ID of the workspace to update.
-        workspace_update: the workspace to use to update
+        project_name_or_id: Name or ID of the project to update.
+        project_update: the project to use to update
 
     Returns:
-        The updated workspace.
+        The updated project.
     """
     return verify_permissions_and_update_entity(
-        id=workspace_name_or_id,
-        update_model=workspace_update,
-        get_method=zen_store().get_workspace,
-        update_method=zen_store().update_workspace,
+        id=project_name_or_id,
+        update_model=project_update,
+        get_method=zen_store().get_project,
+        update_method=zen_store().update_project,
     )
 
 
+# TODO: kept for backwards compatibility only; to be removed after the migration
+@workspace_router.delete(
+    "/{project_name_or_id}",
+    responses={401: error_response, 404: error_response, 422: error_response},
+    deprecated=True,
+)
 @router.delete(
-    "/{workspace_name_or_id}",
+    "/{project_name_or_id}",
     responses={401: error_response, 404: error_response, 422: error_response},
 )
 @handle_exceptions
-def delete_workspace(
-    workspace_name_or_id: Union[str, UUID],
+def delete_project(
+    project_name_or_id: Union[str, UUID],
     _: AuthContext = Security(authorize),
 ) -> None:
-    """Deletes a workspace.
+    """Deletes a project.
 
     Args:
-        workspace_name_or_id: Name or ID of the workspace.
+        project_name_or_id: Name or ID of the project.
     """
     verify_permissions_and_delete_entity(
-        id=workspace_name_or_id,
-        get_method=zen_store().get_workspace,
-        delete_method=zen_store().delete_workspace,
+        id=project_name_or_id,
+        get_method=zen_store().get_project,
+        delete_method=zen_store().delete_project,
     )
 
 
+# TODO: kept for backwards compatibility only; to be removed after the migration
+@workspace_router.get(
+    "/{project_name_or_id}" + STATISTICS,
+    responses={401: error_response, 404: error_response, 422: error_response},
+    deprecated=True,
+)
 @router.get(
-    "/{workspace_name_or_id}" + STATISTICS,
+    "/{project_name_or_id}" + STATISTICS,
     responses={401: error_response, 404: error_response, 422: error_response},
 )
 @handle_exceptions
-def get_workspace_statistics(
-    workspace_name_or_id: Union[str, UUID],
+def get_project_statistics(
+    project_name_or_id: Union[str, UUID],
     auth_context: AuthContext = Security(authorize),
-) -> WorkspaceStatistics:
-    """Gets statistics of a workspace.
+) -> ProjectStatistics:
+    """Gets statistics of a project.
 
     # noqa: DAR401
 
     Args:
-        workspace_name_or_id: Name or ID of the workspace to get statistics for.
+        project_name_or_id: Name or ID of the project to get statistics for.
         auth_context: Authentication context.
 
     Returns:
-        All pipelines within the workspace.
+        Project statistics.
     """
-    workspace = verify_permissions_and_get_entity(
-        id=workspace_name_or_id,
-        get_method=zen_store().get_workspace,
+    project = verify_permissions_and_get_entity(
+        id=project_name_or_id,
+        get_method=zen_store().get_project,
     )
 
     user_id = auth_context.user.id
 
-    run_filter = PipelineRunFilter(workspace=workspace.id)
+    run_filter = PipelineRunFilter(project=project.id)
     run_filter.configure_rbac(
         authenticated_user_id=user_id,
         id=get_allowed_resource_ids(resource_type=ResourceType.PIPELINE_RUN),
     )
 
-    pipeline_filter = PipelineFilter(workspace=workspace.id)
+    pipeline_filter = PipelineFilter(project=project.id)
     pipeline_filter.configure_rbac(
         authenticated_user_id=user_id,
         id=get_allowed_resource_ids(resource_type=ResourceType.PIPELINE),
     )
 
-    return WorkspaceStatistics(
+    return ProjectStatistics(
         pipelines=zen_store().count_pipelines(filter_model=pipeline_filter),
         runs=zen_store().count_runs(filter_model=run_filter),
     )

zenml/zen_server/routers/run_metadata_endpoints.py

@@ -28,9 +28,7 @@ from zenml.zen_server.rbac.utils import (
     batch_verify_permissions_for_models,
     verify_permission_for_model,
 )
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import handle_exceptions, zen_store
 
 router = APIRouter(
@@ -47,7 +45,7 @@ router = APIRouter(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + RUN_METADATA,
+    "/{project_name_or_id}" + RUN_METADATA,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["run_metadata"],
@@ -55,22 +53,22 @@ router = APIRouter(
 @handle_exceptions
 def create_run_metadata(
     run_metadata: RunMetadataRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     auth_context: AuthContext = Security(authorize),
 ) -> None:
     """Creates run metadata.
 
     Args:
         run_metadata: The run metadata to create.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
         auth_context: Authentication context.
 
     Raises:
         RuntimeError: If the resource type is not supported.
     """
-    if workspace_name_or_id:
-        workspace = zen_store().get_workspace(workspace_name_or_id)
-        run_metadata.workspace = workspace.id
+    if project_name_or_id:
+        project = zen_store().get_project(project_name_or_id)
+        run_metadata.project = project.id
 
     run_metadata.user = auth_context.user.id
 

zenml/zen_server/routers/run_templates_endpoints.py

@@ -41,9 +41,7 @@ from zenml.zen_server.rbac.endpoint_utils import (
 )
 from zenml.zen_server.rbac.models import Action, ResourceType
 from zenml.zen_server.rbac.utils import verify_permission
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
@@ -65,7 +63,7 @@ router = APIRouter(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + RUN_TEMPLATES,
+    "/{project_name_or_id}" + RUN_TEMPLATES,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["run_templates"],
@@ -73,21 +71,21 @@ router = APIRouter(
 @handle_exceptions
 def create_run_template(
     run_template: RunTemplateRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     _: AuthContext = Security(authorize),
 ) -> RunTemplateResponse:
     """Create a run template.
 
     Args:
         run_template: Run template to create.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
 
     Returns:
         The created run template.
     """
-    if workspace_name_or_id:
-        workspace = zen_store().get_workspace(workspace_name_or_id)
-        run_template.workspace = workspace.id
+    if project_name_or_id:
+        project = zen_store().get_project(project_name_or_id)
+        run_template.project = project.id
 
     return verify_permissions_and_create_entity(
         request_model=run_template,
@@ -102,7 +100,7 @@ def create_run_template(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.get(
-    "/{workspace_name_or_id}" + RUN_TEMPLATES,
+    "/{project_name_or_id}" + RUN_TEMPLATES,
     responses={401: error_response, 404: error_response, 422: error_response},
     deprecated=True,
     tags=["run_templates"],
@@ -112,7 +110,7 @@ def list_run_templates(
     filter_model: RunTemplateFilter = Depends(
         make_dependable(RunTemplateFilter)
     ),
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     hydrate: bool = False,
     _: AuthContext = Security(authorize),
 ) -> Page[RunTemplateResponse]:
@@ -121,15 +119,15 @@ def list_run_templates(
     Args:
         filter_model: Filter model used for pagination, sorting,
             filtering.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
         hydrate: Flag deciding whether to hydrate the output model(s)
             by including metadata fields in the response.
 
     Returns:
         Page of run templates.
     """
-    if workspace_name_or_id:
-        filter_model.workspace = workspace_name_or_id
+    if project_name_or_id:
+        filter_model.project = project_name_or_id
 
     return verify_permissions_and_list_entities(
         filter_model=filter_model,
@@ -253,18 +251,18 @@ if server_config().workload_manager_enabled:
                 hydrate=True,
             )
             analytics_handler.metadata = {
-                "workspace_id": template.workspace.id,
+                "project_id": template.project.id,
             }
 
             verify_permission(
                 resource_type=ResourceType.PIPELINE_DEPLOYMENT,
                 action=Action.CREATE,
-                workspace_id=template.workspace.id,
+                project_id=template.project.id,
             )
             verify_permission(
                 resource_type=ResourceType.PIPELINE_RUN,
                 action=Action.CREATE,
-                workspace_id=template.workspace.id,
+                project_id=template.project.id,
             )
 
             return run_template(

zenml/zen_server/routers/runs_endpoints.py

@@ -51,9 +51,7 @@ from zenml.zen_server.rbac.models import Action, ResourceType
 from zenml.zen_server.rbac.utils import (
     verify_permission_for_model,
 )
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
@@ -77,7 +75,7 @@ logger = get_logger(__name__)
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + RUNS,
+    "/{project_name_or_id}" + RUNS,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["runs"],
@@ -85,22 +83,22 @@ logger = get_logger(__name__)
 @handle_exceptions
 def get_or_create_pipeline_run(
     pipeline_run: PipelineRunRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     _: AuthContext = Security(authorize),
 ) -> Tuple[PipelineRunResponse, bool]:
     """Get or create a pipeline run.
 
     Args:
         pipeline_run: Pipeline run to create.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
 
     Returns:
         The pipeline run and a boolean indicating whether the run was created
         or not.
     """
-    if workspace_name_or_id:
-        workspace = zen_store().get_workspace(workspace_name_or_id)
-        pipeline_run.workspace = workspace.id
+    if project_name_or_id:
+        project = zen_store().get_project(project_name_or_id)
+        pipeline_run.project = project.id
 
     return verify_permissions_and_get_or_create_entity(
         request_model=pipeline_run,
@@ -115,7 +113,7 @@ def get_or_create_pipeline_run(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.get(
-    "/{workspace_name_or_id}" + RUNS,
+    "/{project_name_or_id}" + RUNS,
     responses={401: error_response, 404: error_response, 422: error_response},
     deprecated=True,
     tags=["runs"],
@@ -125,7 +123,7 @@ def list_runs(
     runs_filter_model: PipelineRunFilter = Depends(
         make_dependable(PipelineRunFilter)
     ),
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     hydrate: bool = False,
     _: AuthContext = Security(authorize),
 ) -> Page[PipelineRunResponse]:
@@ -133,15 +131,15 @@ def list_runs(
 
     Args:
         runs_filter_model: Filter model used for pagination, sorting, filtering.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
         hydrate: Flag deciding whether to hydrate the output model(s)
             by including metadata fields in the response.
 
     Returns:
         The pipeline runs according to query filters.
     """
-    if workspace_name_or_id:
-        runs_filter_model.workspace = workspace_name_or_id
+    if project_name_or_id:
+        runs_filter_model.project = project_name_or_id
 
     return verify_permissions_and_list_entities(
         filter_model=runs_filter_model,

zenml/zen_server/routers/schedule_endpoints.py

@@ -31,9 +31,7 @@ from zenml.zen_server.exceptions import error_response
 from zenml.zen_server.rbac.endpoint_utils import (
     verify_permissions_and_create_entity,
 )
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
@@ -54,7 +52,7 @@ router = APIRouter(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + SCHEDULES,
+    "/{project_name_or_id}" + SCHEDULES,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["schedules"],
@@ -62,22 +60,22 @@ router = APIRouter(
 @handle_exceptions
 def create_schedule(
     schedule: ScheduleRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     auth_context: AuthContext = Security(authorize),
 ) -> ScheduleResponse:
     """Creates a schedule.
 
     Args:
         schedule: Schedule to create.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
         auth_context: Authentication context.
 
     Returns:
         The created schedule.
     """
-    if workspace_name_or_id:
-        workspace = zen_store().get_workspace(workspace_name_or_id)
-        schedule.workspace = workspace.id
+    if project_name_or_id:
+        project = zen_store().get_project(project_name_or_id)
+        schedule.project = project.id
 
     # NOTE: no RBAC is enforced currently for schedules, but we're
     # keeping the RBAC checks here for consistency
@@ -94,7 +92,7 @@ def create_schedule(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.get(
-    "/{workspace_name_or_id}" + SCHEDULES,
+    "/{project_name_or_id}" + SCHEDULES,
     responses={401: error_response, 404: error_response, 422: error_response},
     deprecated=True,
     tags=["schedules"],
@@ -104,7 +102,7 @@ def list_schedules(
     schedule_filter_model: ScheduleFilter = Depends(
         make_dependable(ScheduleFilter)
     ),
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     hydrate: bool = False,
     _: AuthContext = Security(authorize),
 ) -> Page[ScheduleResponse]:
@@ -113,15 +111,15 @@ def list_schedules(
     Args:
         schedule_filter_model: Filter model used for pagination, sorting,
             filtering
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
         hydrate: Flag deciding whether to hydrate the output model(s)
             by including metadata fields in the response.
 
     Returns:
         List of schedule objects.
     """
-    if workspace_name_or_id:
-        schedule_filter_model.workspace = workspace_name_or_id
+    if project_name_or_id:
+        schedule_filter_model.project = project_name_or_id
 
     return zen_store().list_schedules(
         schedule_filter_model=schedule_filter_model,

zenml/zen_server/routers/secrets_endpoints.py

@@ -49,9 +49,7 @@ from zenml.zen_server.rbac.utils import (
     is_owned_by_authenticated_user,
     verify_permission,
 )
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,