From ddb176a3a99367a91ba266e557d914a1beb0f02c Mon Sep 17 00:00:00 2001 From: Bernd Hufmann Date: Mon, 4 Nov 2024 13:44:43 -0500 Subject: [PATCH] swagger: Fix response descriptions for successful DP creation Update also method name of the provider creation operation. Signed-off-by: Bernd Hufmann --- .../rest/core/services/DataProviderService.java | 11 ++++++----- .../jersey/rest/core/services/EndpointConstants.java | 3 ++- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/DataProviderService.java b/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/DataProviderService.java index e60cba07..3c4dd333 100644 --- a/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/DataProviderService.java +++ b/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/DataProviderService.java @@ -14,6 +14,7 @@ import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.ANN; import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.CFG_CREATE_DESC; import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.CFG_KEYS_DESC; +import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.CFG_OUTPUT_ID; import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.CFG_TYPE_ID; import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.COLUMNS; import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.COLUMNS_EX; @@ -1249,9 +1250,9 @@ public Response getConfigurationType( * @param expUUID * desired experiment UUID * @param outputId - * Output ID for the data provider to query + * ID of the output provider to create a derived output from * @param queryParameters - * the query parameters used to create a data provider + * the query parameters used to create a output provider * @return a list of data provider descriptors */ @SuppressWarnings("null") @@ -1261,13 +1262,13 @@ 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, + @Parameter(description = CFG_OUTPUT_ID) @PathParam("outputId") String outputId, @RequestBody(description = CFG_CREATE_DESC + " " + CFG_KEYS_DESC, content = { @Content(examples = @ExampleObject(DP_CFG_EX), schema = @Schema(implementation = org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.model.OutputConfigurationQueryParameters.class)) }, required = true) OutputConfigurationQueryParameters queryParameters) { diff --git a/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/EndpointConstants.java b/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/EndpointConstants.java index c718fe34..c883d151 100644 --- a/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/EndpointConstants.java +++ b/trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/services/EndpointConstants.java @@ -108,8 +108,9 @@ public final class EndpointConstants { * Swagger @Parameter description constants, named after their parameter * name; alphabetical order. */ - static final String CFG_TYPE_ID = "The configuration source type ID"; //$NON-NLS-1$ static final String CFG_CONFIG_ID = "The configuration instance ID"; //$NON-NLS-1$ + static final String CFG_OUTPUT_ID = "ID of the output provider to create a derived output from"; //$NON-NLS-1$ + static final String CFG_TYPE_ID = "The configuration source type ID"; //$NON-NLS-1$ static final String DERIVED_OUTPUT_ID = "ID of the derived output provider"; //$NON-NLS-1$ static final String EXP_UUID = "UUID of the experiment to query"; //$NON-NLS-1$ static final String MARKER_SET_ID = "The optional requested marker set's id"; //$NON-NLS-1$