Merge pull request galaxyproject#18732 from mvdbeek/drop_response_body_delete_datasets

Don't serialize view of item in delete/purge request

Author: jdavcs

client/src/api/schema/schema.ts

@@ -9924,30 +9924,6 @@ export interface components {
              */
             stop_job: boolean;
         };
-        /**
-         * DeleteHistoryContentResult
-         * @description Contains minimum information about the deletion state of a history item.
-         *
-         *     Can also contain any other properties of the item.
-         */
-        DeleteHistoryContentResult: {
-            /**
-             * Deleted
-             * @description True if the item was successfully deleted.
-             */
-            deleted: boolean;
-            /**
-             * ID
-             * @description The encoded ID of the history item.
-             * @example 0123456789ABCDEF
-             */
-            id: string;
-            /**
-             * Purged
-             * @description True if the item was successfully removed from disk.
-             */
-            purged?: boolean | null;
-        };
         /** DeleteHistoryPayload */
         DeleteHistoryPayload: {
             /**
@@ -24261,10 +24237,6 @@ export interface operations {
                  * @description Whether to stop the creating job if all outputs of the job have been deleted.
                  */
                 stop_job?: boolean | null;
-                /** @description View to be passed to the serializer */
-                view?: string | null;
-                /** @description Comma-separated list of keys to be passed to the serializer */
-                keys?: string | null;
             };
             header?: {
                 /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
@@ -24282,23 +24254,28 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Request has been executed. */
+            /** @description Successful Response */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["DeleteHistoryContentResult"];
+                    "application/json": unknown;
                 };
             };
             /** @description Request accepted, processing will finish later. */
             202: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/json": components["schemas"]["DeleteHistoryContentResult"];
+                content?: never;
+            };
+            /** @description Request has been executed. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
                 };
+                content?: never;
             };
             /** @description Request Error */
             "4XX": {
@@ -30217,10 +30194,6 @@ export interface operations {
                  * @description Whether to stop the creating job if all outputs of the job have been deleted.
                  */
                 stop_job?: boolean | null;
-                /** @description View to be passed to the serializer */
-                view?: string | null;
-                /** @description Comma-separated list of keys to be passed to the serializer */
-                keys?: string | null;
             };
             header?: {
                 /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
@@ -30240,23 +30213,28 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Request has been executed. */
+            /** @description Successful Response */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["DeleteHistoryContentResult"];
+                    "application/json": unknown;
                 };
             };
             /** @description Request accepted, processing will finish later. */
             202: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/json": components["schemas"]["DeleteHistoryContentResult"];
+                content?: never;
+            };
+            /** @description Request has been executed. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
                 };
+                content?: never;
             };
             /** @description Request Error */
             "4XX": {
@@ -30634,10 +30612,6 @@ export interface operations {
                  * @description Whether to stop the creating job if all outputs of the job have been deleted.
                  */
                 stop_job?: boolean | null;
-                /** @description View to be passed to the serializer */
-                view?: string | null;
-                /** @description Comma-separated list of keys to be passed to the serializer */
-                keys?: string | null;
             };
             header?: {
                 /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
@@ -30659,23 +30633,28 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Request has been executed. */
+            /** @description Successful Response */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["DeleteHistoryContentResult"];
+                    "application/json": unknown;
                 };
             };
             /** @description Request accepted, processing will finish later. */
             202: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/json": components["schemas"]["DeleteHistoryContentResult"];
+                content?: never;
+            };
+            /** @description Request has been executed. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
                 };
+                content?: never;
             };
             /** @description Request Error */
             "4XX": {

lib/galaxy/schema/schema.py

@@ -3592,28 +3592,6 @@ class DeleteHistoryContentPayload(Model):
     )
 
 
-class DeleteHistoryContentResult(Model):
-    """Contains minimum information about the deletion state of a history item.
-
-    Can also contain any other properties of the item."""
-
-    id: DecodedDatabaseIdField = Field(
-        ...,
-        title="ID",
-        description="The encoded ID of the history item.",
-    )
-    deleted: bool = Field(
-        ...,
-        title="Deleted",
-        description="True if the item was successfully deleted.",
-    )
-    purged: Optional[bool] = Field(
-        default=None,
-        title="Purged",
-        description="True if the item was successfully removed from disk.",
-    )
-
-
 class HistoryContentsArchiveDryRunResult(RootModel):
     """
     Contains a collection of filepath/filename entries that represent

lib/galaxy/webapps/galaxy/api/history_contents.py

@@ -44,7 +44,6 @@
     DatasetAssociationRoles,
     DatasetSourceType,
     DeleteHistoryContentPayload,
-    DeleteHistoryContentResult,
     HistoryContentBulkOperationPayload,
     HistoryContentBulkOperationResult,
     HistoryContentsArchiveDryRunResult,
@@ -146,13 +145,11 @@ def ContentTypeQueryParam(default: Optional[HistoryContentType]):
 
 
 CONTENT_DELETE_RESPONSES = {
-    200: {
-        "description": "Request has been executed.",
-        "model": DeleteHistoryContentResult,
-    },
     202: {
         "description": "Request accepted, processing will finish later.",
-        "model": DeleteHistoryContentResult,
+    },
+    204: {
+        "description": "Request has been executed.",
     },
 }
 
@@ -894,7 +891,6 @@ def delete_typed(
         id: HistoryItemIDPathParam,
         trans: ProvidesHistoryContext = DependsOnTrans,
         type: HistoryContentType = ContentTypePathParam,
-        serialization_params: SerializationParams = Depends(query_serialization_params),
         purge: Optional[bool] = PurgeQueryParam,
         recursive: Optional[bool] = RecursiveQueryParam,
         stop_job: Optional[bool] = StopJobQueryParam,
@@ -910,7 +906,6 @@ def delete_typed(
             trans,
             id,
             type,
-            serialization_params,
             purge,
             recursive,
             stop_job,
@@ -930,7 +925,6 @@ def delete_legacy(
         id: HistoryItemIDPathParam,
         trans: ProvidesHistoryContext = DependsOnTrans,
         type: HistoryContentType = ContentTypeQueryParam(default=HistoryContentType.dataset),
-        serialization_params: SerializationParams = Depends(query_serialization_params),
         purge: Optional[bool] = PurgeQueryParam,
         recursive: Optional[bool] = RecursiveQueryParam,
         stop_job: Optional[bool] = StopJobQueryParam,
@@ -946,7 +940,6 @@ def delete_legacy(
             trans,
             id,
             type,
-            serialization_params,
             purge,
             recursive,
             stop_job,
@@ -964,7 +957,6 @@ def delete_dataset(
         response: Response,
         dataset_id: HistoryItemIDPathParam,
         trans: ProvidesHistoryContext = DependsOnTrans,
-        serialization_params: SerializationParams = Depends(query_serialization_params),
         purge: Optional[bool] = PurgeQueryParam,
         recursive: Optional[bool] = RecursiveQueryParam,
         stop_job: Optional[bool] = StopJobQueryParam,
@@ -980,7 +972,6 @@ def delete_dataset(
             trans,
             dataset_id,
             HistoryContentType.dataset,
-            serialization_params,
             purge,
             recursive,
             stop_job,
@@ -993,7 +984,6 @@ def _delete(
         trans: ProvidesHistoryContext,
         id: DecodedDatabaseIdField,
         type: HistoryContentType,
-        serialization_params: SerializationParams,
         purge: Optional[bool],
         recursive: Optional[bool],
         stop_job: Optional[bool],
@@ -1005,17 +995,14 @@ def _delete(
         payload.purge = payload.purge or purge is True
         payload.recursive = payload.recursive or recursive is True
         payload.stop_job = payload.stop_job or stop_job is True
-        rval = self.service.delete(
+        if self.service.delete(
             trans,
             id=id,
-            serialization_params=serialization_params,
             contents_type=type,
             payload=payload,
-        )
-        async_result = rval.pop("async_result", None)
-        if async_result:
-            response.status_code = status.HTTP_202_ACCEPTED
-        return rval
+        ):
+            return Response(status_code=status.HTTP_202_ACCEPTED)
+        return Response(status_code=status.HTTP_204_NO_CONTENT)
 
     @router.get(
         "/api/histories/{history_id}/contents/archive/{filename}.{format}",

lib/galaxy/webapps/galaxy/services/history_contents.py

@@ -739,20 +739,18 @@ def delete(
         self,
         trans,
         id: DecodedDatabaseIdField,
-        serialization_params: SerializationParams,
         contents_type: HistoryContentType,
         payload: DeleteHistoryContentPayload,
     ):
         """
         Delete the history content with the given ``id`` and specified type (defaults to dataset)
         """
         if contents_type == HistoryContentType.dataset:
-            return self.__delete_dataset(trans, id, payload.purge, payload.stop_job, serialization_params)
+            return self.__delete_dataset(trans, id, payload.purge, payload.stop_job)
         elif contents_type == HistoryContentType.dataset_collection:
-            async_result = self.dataset_collection_manager.delete(
+            return self.dataset_collection_manager.delete(
                 trans, "history", id, recursive=payload.recursive, purge=payload.purge
             )
-            return {"id": self.encode_id(id), "deleted": True, "async_result": async_result is not None}
         else:
             raise exceptions.UnknownContentsType(f"Unknown contents type: {contents_type}")
 
@@ -866,24 +864,16 @@ def build_archive_files_and_paths(content, *parents):
             archive.write(file_path, archive_path)
         return archive
 
-    def __delete_dataset(
-        self, trans, id: DecodedDatabaseIdField, purge: bool, stop_job: bool, serialization_params: SerializationParams
-    ):
+    def __delete_dataset(self, trans, id: DecodedDatabaseIdField, purge: bool, stop_job: bool):
         hda = self.hda_manager.get_owned(id, trans.user, current_history=trans.history)
         self.history_manager.error_unless_mutable(hda.history)
         self.hda_manager.error_if_uploading(hda)
 
-        async_result = None
         if purge:
-            async_result = self.hda_manager.purge(hda, user=trans.user)
+            return self.hda_manager.purge(hda, user=trans.user)
         else:
             self.hda_manager.delete(hda, stop_job=stop_job)
-        serialization_params.default_view = "detailed"
-        rval = self.hda_serializer.serialize_to_view(
-            hda, user=trans.user, trans=trans, encode_id=False, **serialization_params.model_dump()
-        )
-        rval["async_result"] = async_result is not None
-        return rval
+        return None
 
     def __update_dataset_collection(self, trans, id: DecodedDatabaseIdField, payload: dict[str, Any]):
         return self.dataset_collection_manager.update(trans, "history", id, payload)

lib/galaxy_test/api/test_datasets.py

@@ -672,7 +672,7 @@ def _run_cancel_job(self, history_id: str, use_query_params: bool = False):
             history_id, output_hda_id, stop_job=True, use_query_params=use_query_params
         )
         self._assert_status_code_is_ok(delete_response)
-        deleted_hda = delete_response.json()
+        deleted_hda = self.dataset_populator.get_history_dataset_details(history_id, content_id=output_hda_id)
         assert deleted_hda["deleted"], deleted_hda
 
         # The job should be cancelled

lib/galaxy_test/api/test_history_contents.py

@@ -692,7 +692,7 @@ def _check_pair_creation(self, history_id: str, endpoint, payload):
         assert not dataset_collection["deleted"]
 
         delete_response = self._delete(collection_url)
-        self._assert_status_code_is(delete_response, 200)
+        self._assert_status_code_is_ok(delete_response)
 
         show_response = self._get(collection_url)
         dataset_collection = show_response.json()