swagger: Fix response descriptions for successful DP creation

Update also method name of the data provider creation operation. Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
eclipse-tracecompass-incubator · Nov 4, 2024 · 9591df9 · 9591df9
1 parent c39e98e
commit 9591df9
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/...ompass/incubator/internal/trace/server/jersey/rest/core/services/DataProviderService.java b/...ompass/incubator/internal/trace/server/jersey/rest/core/services/DataProviderService.java
@@ -1259,11 +1259,11 @@ public Response getConfigurationType(
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
     @Operation(summary = "Get a derived data provider from a input configuration", responses = {
-            @ApiResponse(responseCode = "200", description = "Returns a list of output provider descriptors", content = @Content(array = @ArraySchema(schema = @Schema(implementation = DataProvider.class)))),
+            @ApiResponse(responseCode = "200", description = "Returns the derived data provider descriptor.", content = @Content(schema = @Schema(implementation = DataProvider.class))),
             @ApiResponse(responseCode = "400", description = INVALID_PARAMETERS, content = @Content(schema = @Schema(implementation = String.class))),
             @ApiResponse(responseCode = "404", description = PROVIDER_CONFIG_NOT_FOUND, content = @Content(schema = @Schema(implementation = String.class))),
     })
-    public Response createDataProvider(
+    public Response createProvider(
                 @Parameter(description = EXP_UUID) @PathParam("expUUID") UUID expUUID,
                 @Parameter(description = OUTPUT_ID) @PathParam("outputId") String outputId,
                 @RequestBody(description = CFG_CREATE_DESC + " " + CFG_KEYS_DESC, content = {
@@ -1311,7 +1311,7 @@ public Response createDataProvider(
     }
 
     /**
-     * DELETE a derived data provider from created by a given data provider
+     * DELETE a derived data provider created from a given data provider
      *
      * @param expUUID
      *            desired experiment UUID
@@ -1325,8 +1325,8 @@ public Response createDataProvider(
     @Path("/{outputId}/{derivedOutputId}")
     @Tag(name = OCG)
     @Produces(MediaType.APPLICATION_JSON)
-    @Operation(summary = "Delete a configuration instance of a given configuration type", responses = {
-            @ApiResponse(responseCode = "200", description = "Returns the deleted derived data provider descriptor. The derived data provider (and it's configuration) was successfully deleted.", content = @Content(schema = @Schema(implementation = DataProvider.class))),
+    @Operation(summary = "Delete a derived data provider (and it's derived configuration).", responses = {
+            @ApiResponse(responseCode = "200", description = "Returns the deleted derived data provider descriptor. The derived data provider (and it configuration) was successfully deleted.", content = @Content(schema = @Schema(implementation = DataProvider.class))),
             @ApiResponse(responseCode = "400", description = INVALID_PARAMETERS, content = @Content(schema = @Schema(implementation = String.class))),
             @ApiResponse(responseCode = "404", description = PROVIDER_CONFIG_NOT_FOUND, content = @Content(schema = @Schema(implementation = String.class))),
     })