Fix issue with @ResponseStatus and @ApiResponse being out of sync. (g…

…eonetwork#7588) * Fix issue with @ResponseStatus and @ApiResponse being out of sync. Update @ApiResponse so that they are in sync with @ResponseStatus * Change Delete on record/tags so that it returns OK 200.
GeoCat · Jan 9, 2024 · 6dacf28 · 6dacf28
1 parent b300811
commit 6dacf28
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataInsertDeleteApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataInsertDeleteApi.java
@@ -253,7 +253,7 @@ public void deleteRecord(
             MediaType.APPLICATION_JSON_VALUE
         }
     )
-    @ApiResponses(value = {@ApiResponse(responseCode = "204", description = "Report about deleted records."),
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Report about deleted records."),
         @ApiResponse(responseCode = "403", description = ApiParams.API_RESPONSE_NOT_ALLOWED_ONLY_EDITOR)})
     @PreAuthorize("hasAuthority('Editor')")
     @ResponseStatus(HttpStatus.OK)

diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataProcessApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataProcessApi.java
@@ -162,7 +162,7 @@ ResponseEntity<Element> processRecordPreview(
         RequestMethod.POST,}, produces = MediaType.APPLICATION_XML_VALUE)
     @PreAuthorize("hasAuthority('Editor')")
     @ResponseStatus(HttpStatus.OK)
-    @ApiResponses(value = {@ApiResponse(responseCode = "204", description = "Record processed and saved."),
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Record processed and saved."),
         @ApiResponse(responseCode = "403", description = ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_EDIT)})
     public @ResponseBody
     ResponseEntity processRecord(

diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataTagApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataTagApi.java
@@ -389,9 +389,9 @@ public MetadataProcessingReport tagRecords(
         produces = {
             MediaType.APPLICATION_JSON_VALUE
         })
-    @ResponseStatus(value = HttpStatus.NO_CONTENT)
+    @ResponseStatus(value = HttpStatus.OK)
     @ApiResponses(value = {
-        @ApiResponse(responseCode = "201", description = "Report about removed records."),
+        @ApiResponse(responseCode = "200", description = "Report about removed records."),
         @ApiResponse(responseCode = "403", description = ApiParams.API_RESPONSE_NOT_ALLOWED_ONLY_EDITOR)
     })
     @PreAuthorize("hasAuthority('Editor')")

diff --git a/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsApi.java b/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsApi.java
@@ -250,7 +250,7 @@ public MetadataResource putResourceFromURL(
     // @PreAuthorize("permitAll")
     @RequestMapping(value = "/{resourceId:.+}", method = RequestMethod.GET)
     @ResponseStatus(value = HttpStatus.OK)
-    @ApiResponses(value = {@ApiResponse(responseCode = "201", description = "Record attachment."),
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Record attachment."),
         @ApiResponse(responseCode = "403", description = "Operation not allowed. "
             + "User needs to be able to download the resource.")})
     public void getResource(

diff --git a/services/src/main/java/org/fao/geonet/api/sources/SourcesApi.java b/services/src/main/java/org/fao/geonet/api/sources/SourcesApi.java
@@ -272,7 +272,7 @@ public ResponseEntity updateSource(
     @PreAuthorize("hasAuthority('Administrator')")
     @ResponseStatus(HttpStatus.NO_CONTENT)
     @ApiResponses(value = {
-        @ApiResponse(responseCode = "201", description = "Source deleted."),
+        @ApiResponse(responseCode = "204", description = "Source deleted."),
         @ApiResponse(responseCode = "403", description = ApiParams.API_RESPONSE_NOT_ALLOWED_ONLY_ADMIN)
     })
     @ResponseBody