server: Update query parameters for configurations

[bhufmann]

PR based on PR #66, which commits are included.

An additional commit is added:

• server: Update query parameters for configurations

This commit also includes improved swagger updates of related topics.

Signed-off-by: Bernd Hufmann [email protected]

[PatrickTasse]

I'm not sure what are pros and cons of describing them here vs. explicitly as in RequestedQueryParameters? I think with the latter they will be shown when expanding the parameters in the generated TSP?

[bhufmann]

I understand. Using something RequestedQueryParameters and I tried it. The issues I had is the different ways we supply the custom properties:

1. through JSON schema. This requires the properties key.
2. directly under parameters (e.g. path for custom XML analysis in global configuration)

I had the following. It works well with 1). Do you know how can we support case 2)?

public interface ConfigurationQueryParameters {

    /**
     * @return The parameters.
     */
    @NonNull
    @Schema(required = true)
    ConfigurationParameters getParameters();

    /**
     * No expected properties below, as per current trace-server protocol.
     */
    interface ConfigurationParameters {
        @JsonProperty("name")
        @Schema(description = "Optional, unique name of the configuration. If omitted a unique name will be generated.")
        String getName();
        @JsonProperty("description")
        @Schema(description = "Optional, description of the configuration.")
        String getDescription();
        @Schema(description = "Optional, typeId of the configuration. Omit if it's part of endpoint URI.")
        @JsonProperty("typeId")
        String getTypeId();
        @JsonProperty("properties")
        @Schema(description = "Properties as JSON object as specified in the schema of the corresponding ConfigurationTypeDescriptor. Use key `path` for file URI string values.")
        Map<String, Object> getProperties();
    }
}

[PatrickTasse]

The 'properties' could also be used for global configuration?
It could be as specified in a schema or in a list of paramDescriptors.
We should set the 'required' value for each parameter.

[bhufmann]

The 'properties' could also be used for global configuration? It could be as specified in a schema or in a list of paramDescriptors. We should set the 'required' value for each parameter.

Sounds good. Thanks for the feedback.

[bhufmann]

Done

[PatrickTasse]

These two lines just duplicates of the two lines above them?

[bhufmann]

good eye. Done.

[PatrickTasse]

This line should be moved above the javadoc block

[bhufmann]

Done

[bhufmann]

Fix comment

[bhufmann]

Done

[bhufmann]

Thinking about it a bit more we should call this parameters instead of properties, because the resulting Configuration has a member called parameters instead of properties. It would be not clear otherwise.

[bhufmann]

Done

[PatrickTasse]

I'm OK with that change.