feat(restapi): add deleted boolean to resource responses

This feature adds a "deleted" boolean field to the response of all Resources. The field is set to
true if the resources has been deleted and false otherwise.

It updates the schema generators to include the new field, updates the response builders to
populate the field in responses from the REST API, and update the tests to check for the existence
and type of the field.

Note that the REST API does not currently return deleted resources. A future change will enable this
behavior.

Author: jtsextonMITRE

src/dioptra/restapi/v1/schemas.py

@@ -106,6 +106,12 @@ def generate_base_resource_schema(name: str, snapshot: bool) -> type[Schema]:
             many=True,
             dump_only=True,
         ),
+        "deleted": fields.Bool(
+            attribute="deleted",
+            metadata={"description": f"Whether the {name} resource has been deleted."},
+            dump_only=True,
+            load_default=False,
+        ),
     }
 
     if not snapshot:
@@ -142,6 +148,12 @@ def generate_base_resource_ref_schema(
             metadata={"description": f"URL for accessing the full {name} resource."},
             relative=True,
         ),
+        "deleted": fields.Bool(
+            attribute="deleted",
+            metadata={"description": f"Whether the {name} resource has been deleted."},
+            dump_only=True,
+            load_default=False,
+        ),
     }
 
     if keep_snapshot_id:

src/dioptra/restapi/v1/utils.py

@@ -632,6 +632,7 @@ def build_experiment(experiment_dict: ExperimentDict) -> dict[str, Any]:
         "group": build_group_ref(experiment.resource.owner),
         "created_on": experiment.resource.created_on,
         "last_modified_on": experiment.resource.last_modified_on,
+        "deleted": experiment.resource.is_deleted,
         "snapshot_created_on": experiment.created_on,
         "latest_snapshot": experiment.resource.latest_snapshot_id
         == experiment.resource_snapshot_id,
@@ -702,6 +703,7 @@ def build_entrypoint(entrypoint_dict: EntrypointDict) -> dict[str, Any]:
         "group": build_group_ref(entrypoint.resource.owner),
         "created_on": entrypoint.resource.created_on,
         "last_modified_on": entrypoint.resource.last_modified_on,
+        "deleted": entrypoint.resource.is_deleted,
         "snapshot_created_on": entrypoint.created_on,
         "latest_snapshot": entrypoint.resource.latest_snapshot_id
         == entrypoint.resource_snapshot_id,
@@ -798,6 +800,7 @@ def build_job(job_dict: JobDict) -> dict[str, Any]:
         "created_on": job.resource.created_on,
         "last_modified_on": job.resource.last_modified_on,
         "snapshot_created_on": job.created_on,
+        "deleted": job.resource.is_deleted,
         "latest_snapshot": job.resource.latest_snapshot_id == job.resource_snapshot_id,
         "tags": [build_tag_ref(tag) for tag in job.tags],
     }
@@ -852,6 +855,7 @@ def build_model(model_dict: ModelWithVersionDict) -> dict[str, Any]:
         "latest_snapshot": model.resource.latest_snapshot_id
         == model.resource_snapshot_id,
         "tags": [build_tag_ref(tag) for tag in model.tags],
+        "deleted": model.resource.is_deleted,
         "latest_version": latest_version,
         "versions": versions,
     }
@@ -941,6 +945,7 @@ def build_artifact(artifact_dict: ArtifactDict) -> dict[str, Any]:
         "artifact_uri": artifact.uri,
         "is_dir": artifact.is_dir,
         "file_size": artifact.file_size,
+        "deleted": artifact.resource.is_deleted,
         "task": build_artifact_artifact_task(artifact=artifact),
         "file_url": build_url(f"{ARTIFACTS}/{artifact.resource_id}/contents"),
     }
@@ -1005,6 +1010,7 @@ def build_queue(queue_dict: QueueDict) -> dict[str, Any]:
         "group": build_group_ref(queue.resource.owner),
         "created_on": queue.resource.created_on,
         "last_modified_on": queue.resource.last_modified_on,
+        "deleted": queue.resource.is_deleted,
         "snapshot_created_on": queue.created_on,
         "latest_snapshot": queue.resource.latest_snapshot_id
         == queue.resource_snapshot_id,
@@ -1039,6 +1045,7 @@ def build_plugin(plugin_with_files: PluginWithFilesDict) -> dict[str, Any]:
         "group": build_group_ref(plugin.resource.owner),
         "created_on": plugin.resource.created_on,
         "last_modified_on": plugin.resource.last_modified_on,
+        "deleted": plugin.resource.is_deleted,
         "snapshot_created_on": plugin.created_on,
         "latest_snapshot": plugin.resource.latest_snapshot_id
         == plugin.resource_snapshot_id,
@@ -1070,6 +1077,7 @@ def build_plugin_file(plugin_file_with_plugin: PluginFileDict) -> dict[str, Any]
         "group": build_group_ref(plugin_file.resource.owner),
         "created_on": plugin_file.resource.created_on,
         "last_modified_on": plugin_file.resource.last_modified_on,
+        "deleted": plugin_file.resource.is_deleted,
         "snapshot_created_on": plugin_file.created_on,
         "latest_snapshot": plugin_file.resource.latest_snapshot_id
         == plugin_file.resource_snapshot_id,
@@ -1201,6 +1209,7 @@ def build_plugin_parameter_type(
         "group": build_group_ref(plugin_parameter_type.resource.owner),
         "created_on": plugin_parameter_type.resource.created_on,
         "last_modified_on": plugin_parameter_type.resource.last_modified_on,
+        "deleted": plugin_parameter_type.resource.is_deleted,
         "snapshot_created_on": plugin_parameter_type.created_on,
         "latest_snapshot": plugin_parameter_type.resource.latest_snapshot_id
         == plugin_parameter_type.resource_snapshot_id,

tests/unit/restapi/lib/asserts.py

@@ -35,6 +35,7 @@ def assert_base_resource_contents_match_expectations(response: dict[str, Any]) -
     assert isinstance(response["lastModifiedOn"], str)
     assert isinstance(response["latestSnapshot"], bool)
     assert isinstance(response["hasDraft"], bool)
+    assert isinstance(response["deleted"], bool)
 
     assert helpers.is_iso_format(response["createdOn"])
     assert helpers.is_iso_format(response["snapshotCreatedOn"])

tests/unit/restapi/v1/test_artifact.py

@@ -68,6 +68,7 @@ def assert_artifact_response_contents_matches_expectations(
         "fileUrl",
         "artifactUri",
         "job",
+        "deleted",
     }
     assert set(response.keys()) == expected_keys
 
@@ -85,6 +86,7 @@ def assert_artifact_response_contents_matches_expectations(
     assert isinstance(response["fileUrl"], str)
     assert isinstance(response["artifactUri"], str)
     assert isinstance(response["job"], int)
+    assert isinstance(response["deleted"], bool)
 
     assert response["artifactUri"] == expected_contents["artifactUri"]
     assert response["description"] == expected_contents["description"]

tests/unit/restapi/v1/test_entrypoint.py

@@ -70,7 +70,8 @@ def assert_entrypoint_response_contents_matches_expectations(
         "artifactPlugins",
         "queues",
         "tags",
-    }
+        "deleted",
+}
     assert set(response.keys()) == expected_keys
 
     # Validate the non-Ref fields
@@ -83,6 +84,7 @@ def assert_entrypoint_response_contents_matches_expectations(
     assert isinstance(response["lastModifiedOn"], str)
     assert isinstance(response["latestSnapshot"], bool)
     assert isinstance(response["hasDraft"], bool)
+    assert isinstance(response["deleted"], bool)
 
     assert response["name"] == expected_contents["name"]
     assert response["description"] == expected_contents["description"]

tests/unit/restapi/v1/test_experiment.py

@@ -55,6 +55,7 @@ def assert_experiment_response_contents_matches_expectations(
         "createdOn",
         "snapshotCreatedOn",
         "lastModifiedOn",
+        "deleted",
         "latestSnapshot",
         "hasDraft",
         "name",
@@ -73,6 +74,7 @@ def assert_experiment_response_contents_matches_expectations(
     assert isinstance(response["snapshotCreatedOn"], str)
     assert isinstance(response["lastModifiedOn"], str)
     assert isinstance(response["latestSnapshot"], bool)
+    assert isinstance(response["deleted"], bool)
 
     assert response["name"] == expected_contents["name"]
     assert response["description"] == expected_contents["description"]

tests/unit/restapi/v1/test_job.py

@@ -117,6 +117,7 @@ def assert_job_response_contents_matches_expectations(
         "entrypoint",
         "artifacts",
         "artifactValues",
+        "deleted",
     }
     assert set(response.keys()) == expected_keys
 

tests/unit/restapi/v1/test_model.py

@@ -65,6 +65,7 @@ def assert_model_response_contents_matches_expectations(
         "description",
         "latestVersion",
         "tags",
+        "deleted",
     }
     assert set(response.keys()) == expected_keys
 

tests/unit/restapi/v1/test_plugin.py

@@ -70,6 +70,7 @@ def assert_plugin_response_contents_matches_expectations(
         "description",
         "files",
         "tags",
+        "deleted",
     }
     assert set(response.keys()) == expected_keys
 
@@ -83,6 +84,7 @@ def assert_plugin_response_contents_matches_expectations(
     assert isinstance(response["lastModifiedOn"], str)
     assert isinstance(response["latestSnapshot"], bool)
     assert isinstance(response["hasDraft"], bool)
+    assert isinstance(response["deleted"], bool)
 
     assert response["name"] == expected_contents["name"]
     assert response["description"] == expected_contents["description"]
@@ -284,6 +286,7 @@ def assert_plugin_file_response_contents_matches_expectations(
         "tasks",
         "tags",
         "plugin",
+        "deleted",
     }
     assert set(response.keys()) == expected_keys
 
@@ -298,6 +301,7 @@ def assert_plugin_file_response_contents_matches_expectations(
     assert isinstance(response["lastModifiedOn"], str)
     assert isinstance(response["latestSnapshot"], bool)
     assert isinstance(response["hasDraft"], bool)
+    assert isinstance(response["deleted"], bool)
 
     assert response["filename"] == expected_contents["filename"]
     assert response["description"] == expected_contents["description"]

tests/unit/restapi/v1/test_plugin_parameter_type.py

@@ -275,6 +275,7 @@ def assert_plugin_parameter_type_content_matches_expectations(
         "structure",
         "description",
         "tags",
+        "deleted",
     }
     assert set(response.keys()) == expected_keys
 
@@ -289,6 +290,7 @@ def assert_plugin_parameter_type_content_matches_expectations(
     assert isinstance(response["lastModifiedOn"], str)
     assert isinstance(response["latestSnapshot"], bool)
     assert isinstance(response["hasDraft"], bool)
+    assert isinstance(response["deleted"], bool)
 
     assert response["name"] == expected_contents["name"]
     assert response["structure"] == expected_contents["structure"]