feat(restapi): show_deleted artifacts/entrypoints

Author: jtsextonMITRE

src/dioptra/client/artifacts.py

@@ -78,6 +78,7 @@ def get(
         sort_by: str | None = None,
         descending: bool | None = None,
         search: str | None = None,
+        show_deleted: bool | None = False,
     ) -> T:
         """Get a list of artifacts.
 
@@ -115,6 +116,9 @@ def get(
         if group_id is not None:
             params["groupId"] = group_id
 
+        if show_deleted is not None:
+            params["showDeleted"] = show_deleted
+
         return self._session.get(
             self.url,
             params=params,

src/dioptra/client/entrypoints.py

@@ -713,6 +713,7 @@ def get(
         sort_by: str | None = None,
         descending: bool | None = None,
         search: str | None = None,
+        show_deleted: bool | None = None,
     ) -> T:
         """Get a list of entrypoints.
 
@@ -750,6 +751,9 @@ def get(
         if group_id is not None:
             params["groupId"] = group_id
 
+        if show_deleted is not None:
+            params["showDeleted"] = show_deleted
+
         return self._session.get(
             self.url,
             params=params,

src/dioptra/client/experiments.py

@@ -598,6 +598,7 @@ def get(
         sort_by: str | None = None,
         descending: bool | None = None,
         search: str | None = None,
+        show_deleted: bool | None = False,
     ) -> T:
         """Get a list of experiments.
 
@@ -635,6 +636,9 @@ def get(
         if group_id is not None:
             params["groupId"] = group_id
 
+        if show_deleted is not None:
+            params["showDeleted"] = show_deleted
+
         return self._session.get(
             self.url,
             params=params,

src/dioptra/restapi/v1/artifacts/schema.py

@@ -31,6 +31,7 @@
     GroupIdQueryParametersSchema,
     PagingQueryParametersSchema,
     SearchQueryParametersSchema,
+    ShowDeletedQueryParametersSchema,
     SortByGetQueryParametersSchema,
     generate_base_resource_ref_schema,
     generate_base_resource_schema,
@@ -240,6 +241,7 @@ class ArtifactGetQueryParameters(
     GroupIdQueryParametersSchema,
     SearchQueryParametersSchema,
     SortByGetQueryParametersSchema,
+    ShowDeletedQueryParametersSchema,
 ):
     """The query parameters for the GET method of the /artifacts endpoint."""
 

src/dioptra/restapi/v1/artifacts/service.py

@@ -269,18 +269,29 @@ def get(
                 construct_sql_query_filters(search_string, SEARCHABLE_FIELDS)
             )
 
-        allowed_deleted_values = [False, True] if show_deleted else [False]
 
-        stmt = (
+        if not show_deleted:
+            stmt = (
             select(func.count(models.Artifact.resource_id))
             .join(models.Resource)
             .where(
                 *filters,
-                models.Resource.is_deleted in allowed_deleted_values,  # noqa: E712
+                models.Resource.is_deleted == False,  # noqa: E712
                 models.Resource.latest_snapshot_id
                 == models.Artifact.resource_snapshot_id,
             )
         )
+        else: 
+            stmt = (
+                select(func.count(models.Artifact.resource_id))
+                .join(models.Resource)
+                .where(
+                    *filters,
+                    models.Resource.latest_snapshot_id
+                    == models.Artifact.resource_snapshot_id,
+                )
+            )
+
 
         if output_params:
             stmt = self._apply_ouput_params_filter(stmt, output_params)
@@ -298,19 +309,32 @@ def get(
         if total_num_artifacts == 0:
             return [], total_num_artifacts
 
-        # get latest artifact snapshots
-        latest_artifacts_stmt = (
-            select(models.Artifact)
-            .join(models.Resource)
-            .where(
-                *filters,
-                models.Resource.is_deleted in allowed_deleted_values,  # noqa: E712
-                models.Resource.latest_snapshot_id
-                == models.Artifact.resource_snapshot_id,
+        if not show_deleted:
+            # get latest artifact snapshots
+            latest_artifacts_stmt = (
+                select(models.Artifact)
+                .join(models.Resource)
+                .where(
+                    *filters,
+                    models.Resource.is_deleted == False,  # noqa: E712
+                    models.Resource.latest_snapshot_id
+                    == models.Artifact.resource_snapshot_id,
+                )
+                .offset(page_index)
+                .limit(page_length)
+            )
+        else:
+            latest_artifacts_stmt = (
+                select(models.Artifact)
+                .join(models.Resource)
+                .where(
+                    *filters,
+                    models.Resource.latest_snapshot_id
+                    == models.Artifact.resource_snapshot_id,
+                )
+                .offset(page_index)
+                .limit(page_length)
             )
-            .offset(page_index)
-            .limit(page_length)
-        )
 
         if output_params:
             latest_artifacts_stmt = self._apply_ouput_params_filter(

src/dioptra/restapi/v1/entrypoints/schema.py

@@ -29,6 +29,7 @@
     GroupIdQueryParametersSchema,
     PagingQueryParametersSchema,
     SearchQueryParametersSchema,
+    ShowDeletedQueryParametersSchema,
     SortByGetQueryParametersSchema,
     generate_base_resource_ref_schema,
     generate_base_resource_schema,
@@ -320,5 +321,6 @@ class EntrypointGetQueryParameters(
     GroupIdQueryParametersSchema,
     SearchQueryParametersSchema,
     SortByGetQueryParametersSchema,
+    ShowDeletedQueryParametersSchema,
 ):
     """The query parameters for the GET method of the /entrypoints endpoint."""

src/dioptra/restapi/v1/entrypoints/service.py

@@ -252,18 +252,28 @@ def get(
                 construct_sql_query_filters(search_string, SEARCHABLE_FIELDS)
             )
 
-        allowed_deleted_values = [False, True] if show_deleted else [False]
-
-        stmt = (
-            select(func.count(models.EntryPoint.resource_id))
-            .join(models.Resource)
-            .where(
-                *filters,
-                models.Resource.is_deleted in allowed_deleted_values,  # noqa: E712
-                models.Resource.latest_snapshot_id
-                == models.EntryPoint.resource_snapshot_id,
+        if not show_deleted:
+            stmt = (
+                select(func.count(models.EntryPoint.resource_id))
+                .join(models.Resource)
+                .where(
+                    *filters,
+                    models.Resource.is_deleted == False,  # noqa: E712
+                    models.Resource.latest_snapshot_id
+                    == models.EntryPoint.resource_snapshot_id,
+                )
             )
-        )
+        else: 
+            stmt = (
+                select(func.count(models.EntryPoint.resource_id))
+                .join(models.Resource)
+                .where(
+                    *filters,
+                    models.Resource.latest_snapshot_id
+                    == models.EntryPoint.resource_snapshot_id,
+                )
+            )
+
         total_num_entrypoints = db.session.scalars(stmt).first()
 
         if total_num_entrypoints is None:
@@ -277,18 +287,31 @@ def get(
         if total_num_entrypoints == 0:
             return [], total_num_entrypoints
 
-        entrypoints_stmt = (
-            select(models.EntryPoint)
-            .join(models.Resource)
-            .where(
-                *filters,
-                models.Resource.is_deleted in allowed_deleted_values,  # noqa: E712
-                models.Resource.latest_snapshot_id
-                == models.EntryPoint.resource_snapshot_id,
+        if not show_deleted:
+            entrypoints_stmt = (
+                select(models.EntryPoint)
+                .join(models.Resource)
+                .where(
+                    *filters,
+                    models.Resource.is_deleted == False,  # noqa: E712
+                    models.Resource.latest_snapshot_id
+                    == models.EntryPoint.resource_snapshot_id,
+                )
+                .offset(page_index)
+                .limit(page_length)
+            )
+        else:
+            entrypoints_stmt = (
+                select(models.EntryPoint)
+                .join(models.Resource)
+                .where(
+                    *filters,
+                    models.Resource.latest_snapshot_id
+                    == models.EntryPoint.resource_snapshot_id,
+                )
+                .offset(page_index)
+                .limit(page_length)
             )
-            .offset(page_index)
-            .limit(page_length)
-        )
 
         if sort_by_string and sort_by_string in SORTABLE_FIELDS:
             sort_column = SORTABLE_FIELDS[sort_by_string]

tests/unit/restapi/test_utils.py

@@ -50,6 +50,7 @@ def assert_retrieving_resource_works(
     descending: bool | None = None,
     search: str | None = None,
     paging_info: dict[str, Any] | None = None,
+    show_deleted: bool | None = None
 ) -> None:
     """Build the query string from the provided parameters"""
     query_string: dict[str, Any] = {}
@@ -70,6 +71,9 @@ def assert_retrieving_resource_works(
         query_string["index"] = paging_info["index"]
         query_string["page_length"] = paging_info["page_length"]
 
+    if show_deleted is not None:
+        query_string["show_deleted"] = show_deleted
+
     response = dioptra_client.get(**query_string)
 
     assert_http_response_matches_expected(