fix: update swagger dcumentation for PATCH dataset (#536)

InseeFr · Mar 8, 2024 · 7397786 · 7397786
1 parent 368bdc0
commit 7397786
Showing 1 changed file with 12 additions and 10 deletions.
diff --git a/src/main/java/fr/insee/rmes/webservice/dataset/DatasetResources.java b/src/main/java/fr/insee/rmes/webservice/dataset/DatasetResources.java
@@ -17,6 +17,9 @@
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.*;
 
+import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
+import static org.springframework.http.MediaType.TEXT_PLAIN;
+
 @RestController
 @RequestMapping("/datasets")
 @SecurityRequirement(name = "bearerAuth")
@@ -26,8 +29,6 @@ public class DatasetResources {
 
     final DatasetService datasetService;
 
-    public final String EXAMPLE_NUMBER_OF_OBSERVATION = "{\"observationNumber\":1}";
-
     public DatasetResources(DatasetService datasetService) {
         this.datasetService = datasetService;
     }
@@ -53,35 +54,36 @@ public String getDistributionsByDataset(@PathVariable(Constants.ID) String id) t
         return this.datasetService.getDistributions(id);
     }
 
-    @PostMapping(value = "", consumes = MediaType.APPLICATION_JSON_VALUE)
+    @PostMapping(value = "", consumes = APPLICATION_JSON_VALUE)
     @Operation(operationId = "createDataset", summary = "Create a Dataset")
     @ResponseStatus(HttpStatus.CREATED)
     public String setDataset(
             @Parameter(description = "Dataset", required = true) @RequestBody String body) throws RmesException {
         return this.datasetService.create(body);
     }
 
-    @PutMapping(value = "/{id}", consumes = MediaType.APPLICATION_JSON_VALUE)
+    @PutMapping(value = "/{id}", consumes = APPLICATION_JSON_VALUE)
     @Operation(operationId = "updateDataset", summary = "Update a Dataset")
     public String setDataset(
             @PathVariable("id") String datasetId,
             @Parameter(description = "Dataset", required = true) @RequestBody String body) throws RmesException {
         return this.datasetService.update(datasetId, body);
     }
 
-    @GetMapping(value = "/archivageUnits", consumes = MediaType.APPLICATION_JSON_VALUE)
+    @GetMapping(value = "/archivageUnits", consumes = APPLICATION_JSON_VALUE)
     @Operation(operationId = "getArchivageUnits", summary = "Get all archivage units")
     public String getArchivageUnits() throws RmesException {
         return this.datasetService.getArchivageUnits();
     }
 
-    @PatchMapping(value = "/{id}/observationNumber", consumes = MediaType.APPLICATION_JSON_VALUE)
-    @Operation(operationId = "updateObservationNumber", summary = "Update ObsevationNumber of a dataset")
+    @PatchMapping(value = "/{id}/observationNumber", consumes = APPLICATION_JSON_VALUE)
+    @Operation(operationId = "updateObservationNumber", summary = "Update Observation number of a dataset")
     public void patchDataset(
             @PathVariable("id") String datasetId,
-            @Schema(name ="observationNumber",example = EXAMPLE_NUMBER_OF_OBSERVATION )
-            @Parameter(description = "Dataset", required = true) @RequestBody String observationNumber
+            @Schema(name ="observationNumber", example = "1" )
+            @Parameter(description = "Dataset", required = true)
+            @RequestBody String observationNumber
     ) throws RmesException{
-        this.datasetService.patchDataset(datasetId,observationNumber);
+        this.datasetService.patchDataset(datasetId, observationNumber);
     }
 }