Swagger updates for global and output configuration #103
Conversation
bhufmann
force-pushed
the
swagger-updates
branch
from
b18498e to
5338473
Compare
| @@ -225,7 +225,7 @@ public Response putConfiguration(@Parameter(description = CFG_TYPE_ID) @PathPara | |||
| @RequestBody(description = CFG_UPDATE_DESC + " " + CFG_KEYS_DESC, content = { | |||
| @Content(examples = @ExampleObject("{\"parameters\":{" + CFG_PATH_EX + | |||
| "}}"), schema = @Schema(implementation = org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.model.ConfigurationQueryParameters.class)) | |||
| }, required = true) ConfigurationQueryParameters queryParameters) { | |||
| }, required = true) InputConfigurationQueryParameters queryParameters) { | |||
There was a problem hiding this comment.
Maybe there is an issue with Swagger generation that would prevent this that I don't understand, but would it be possible to have the same concept in the views package with views.ConfigurationQueryParameters here without typeId and views.OutputConfigurationQueryParameters that extends it to add typeId?
There was a problem hiding this comment.
I updated it as you suggested, plus changed the swagger doc generation to use allOf schema tag for inheritance. It seems to work and it's cleaner.
The documentation didn't match the implementation. This PR fixes this. Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
bhufmann
force-pushed
the
swagger-updates
branch
from
5338473 to
62650d9
Compare
There was a problem hiding this comment.
The example object in ConfigurationManagerService (POST and PUT) is missing 'name' which is mandatory, and perhaps 'description' which is optional.
I noticed that in DataProviderService we don't provide any example object and the example is automatically generated with all parameters with default values. Perhaps this one here was made explicit to provide "path" as an example?
I can update the example. For the dp configuration, I didn't put an explicit example, because an example is generated. Generated examples have less details, though. |
Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
bhufmann
merged commit d48d88d
into
eclipse-tracecompass-incubator:master
Add name and description ConfigurationQueryParameters used for global configuration.
This addition enables clients to create derived data providers from an existing data provider. This change also includes updates the "DataProvider" descriptor to include optional parent ID and configuration object to be included in derived data providers.
Signed-off-by: Bernd Hufmann bernd.hufmann@ericsson.com