respond with 204 for successful delete

Author: dmeidlin

src/main/java/org/brapi/test/BrAPITestServer/controller/core/BrAPIController.java

@@ -173,6 +173,10 @@ public <R, T extends BrAPIResponse<R>> ResponseEntity<T> responseOK(T response,
 		return responseOK(response, result, generateEmptyMetadata());
 	}
 
+	public <T> ResponseEntity<T> responseNoContent() {
+		return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+	}
+
 	public <R, T extends BrAPIResponse<R>> ResponseEntity<T> responseOK(T response, R result, Metadata metadata) {
 		response.setMetadata(metadata);
 		response.setResult(result);

src/main/java/org/brapi/test/BrAPITestServer/controller/core/ListsApiController.java

@@ -13,6 +13,8 @@
 import io.swagger.model.core.ListsSingleResponse;
 import io.swagger.api.core.ListsApi;
 
+import org.apache.http.HttpResponse;
+import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerDbIdNotFoundException;
 import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
 import org.brapi.test.BrAPITestServer.model.entity.SearchRequestEntity;
 import org.brapi.test.BrAPITestServer.model.entity.SearchRequestEntity.SearchRequestTypes;
@@ -21,6 +23,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.CrossOrigin;
@@ -134,17 +137,17 @@ public ResponseEntity<ListsSingleResponse> listsListDbIdDelete(
 			@Valid @RequestParam(value = "hardDelete", defaultValue = "false" ,required = false) boolean hardDelete,
 			@RequestHeader(value = "Authorization", required = false) String authorization) throws BrAPIServerException {
 
-		log.debug("Request: " + request.getRequestURI());
-		validateSecurityContext(request, "ROLE_USER");
-		validateAcceptHeader(request);
+			log.debug("Request: " + request.getRequestURI());
+			validateSecurityContext(request, "ROLE_USER");
+			validateAcceptHeader(request);
 
-		if (hardDelete) {
-            listService.deleteList(listDbId);
-			return responseOK(new ListsSingleResponse(), null);
-		}
+			if (hardDelete) {
+				listService.deleteList(listDbId);
+				return responseNoContent();
+			}
 
-		listService.softDeleteList(listDbId);
-		return responseOK(new ListsSingleResponse(), null);
+			listService.softDeleteList(listDbId);
+			return responseNoContent();
 	}
 
 	@CrossOrigin

src/main/java/org/brapi/test/BrAPITestServer/controller/core/TrialsApiController.java

@@ -99,22 +99,25 @@ public ResponseEntity<TrialSingleResponse> trialsTrialDbIdGet(@PathVariable("tri
 		Trial data = trialService.getTrial(trialDbId);
 		return responseOK(new TrialSingleResponse(), data);
 	}
-    @CrossOrigin
+
+	@CrossOrigin
 	@Override
 	public ResponseEntity<TrialSingleResponse> trialsTrialDbIdDelete(
 			@PathVariable("trialDbId") String trialDbId,
 			@Valid @RequestParam(value = "hardDelete", defaultValue = "false", required = false) boolean hardDelete,
 			@RequestHeader(value = "Authorization", required = false) String authorization) throws BrAPIServerException {
+
 		log.debug("Request: " + request.getRequestURI());
 		validateSecurityContext(request, "ROLE_USER");
 		validateAcceptHeader(request);
-		 if (hardDelete) {
-			 trialService.deleteTrial(trialDbId);
-			 return responseOK(new TrialSingleResponse(), null);
-		 }
+
+		if (hardDelete) {
+			trialService.deleteTrial(trialDbId);
+			return responseNoContent();
+		}
 
 		trialService.softDeleteTrial(trialDbId);
-		return responseOK(new TrialSingleResponse(), null);
+		return responseNoContent();
 	}
 
 	@CrossOrigin

src/main/java/org/brapi/test/BrAPITestServer/controller/geno/SamplesApiController.java

@@ -124,16 +124,18 @@ public ResponseEntity<SampleSingleResponse> samplesSampleDbIdDelete(
 			@PathVariable("sampleDbId") String sampleDbId,
 			@Valid @RequestParam(value = "hardDelete", defaultValue = "false", required = false) boolean hardDelete,
 			@RequestHeader(value = "Authorization", required = false) String authorization) throws BrAPIServerException {
+
 		log.debug("Request: " + request.getRequestURI());
 		validateSecurityContext(request, "ROLE_USER");
 		validateAcceptHeader(request);
+
 		if (hardDelete) {
 			sampleService.deleteSample(sampleDbId);
-			return responseOK(new SampleSingleResponse(), null);
+			return responseNoContent();
 		}
 
 		sampleService.softDeleteSample(sampleDbId);
-		return responseOK(new SampleSingleResponse(), null);
+		return responseNoContent();
 	}
 
 	@CrossOrigin

src/main/java/org/brapi/test/BrAPITestServer/service/core/ListService.java

@@ -149,13 +149,17 @@ public void softDeleteListBatch(List<String> listDbIds) {
 	}
 
 	public void deleteList(String listDbId) throws BrAPIServerException {
+		// Soft delete the list first since the method throws a 404 exception if the list is not found
+		softDeleteList(listDbId);
+
+		// Hard delete the list
 		listRepository.deleteAllByIdInBatch(Arrays.asList(listDbId));
 	}
 
 	public void softDeleteList(String listDbId) throws BrAPIServerDbIdNotFoundException {
 		int updatedCount = listRepository.updateSoftDeletedStatus(listDbId, true);
 		if (updatedCount == 0) {
-			throw new BrAPIServerDbIdNotFoundException("List with id " + listDbId + " not found", HttpStatus.NOT_FOUND);
+			throw new BrAPIServerDbIdNotFoundException("list", listDbId, "list database ID", HttpStatus.NOT_FOUND);
 		}
 	}
 

src/main/java/org/brapi/test/BrAPITestServer/service/core/TrialService.java

@@ -166,11 +166,15 @@ public void softDeleteTrialBatch(List<String> trialDbIds) {
 	public void softDeleteTrial(String trialDbId) throws BrAPIServerDbIdNotFoundException {
 		int updatedCount = trialRepository.updateSoftDeletedStatus(trialDbId, true);
 		if (updatedCount == 0) {
-			throw new BrAPIServerDbIdNotFoundException("Trial with id " + trialDbId + " not found", HttpStatus.NOT_FOUND);
+			throw new BrAPIServerDbIdNotFoundException("trial", trialDbId, "trial database ID", HttpStatus.NOT_FOUND);
 		}
 	}
 
 	public void deleteTrial(String trialDbId) throws BrAPIServerException {
+		// Soft delete the trial first since the method throws a 404 exception if the trial is not found
+		softDeleteTrial(trialDbId);
+
+		// Hard delete the trial
 		trialRepository.deleteAllByIdInBatch(Arrays.asList(trialDbId));
 	}
 

src/main/java/org/brapi/test/BrAPITestServer/service/geno/SampleService.java

@@ -156,6 +156,10 @@ public void softDeleteSampleBatch(List<String> sampleDbIds) {
 	}
 
 	public void deleteSample(String sampleDbId) throws BrAPIServerException {
+		// Soft delete the sample first since the method throws a 404 exception if the sample is not found
+		softDeleteSample(sampleDbId);
+
+		// Hard delete the sample
 		sampleRepository.deleteAllByIdInBatch(Arrays.asList(sampleDbId));
 	}