Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tmf: Add support for json-schema file to TmfConfigurationSourceType #141

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

bhufmann
Copy link
Contributor

@bhufmann bhufmann commented Aug 30, 2024

For schema specification see https://json-schema.org/

[Added] support for json-schema file to TmfConfigurationSourceType

See eclipse-cdt-cloud/trace-server-protocol#103

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

@bhufmann bhufmann changed the title tmf: Add support for json-schema to configuration types tmf: Add support for json-schema file to TmfConfigurationSourceType Aug 30, 2024
@bhufmann bhufmann force-pushed the json-schema branch 2 times, most recently from 6ba8935 to 3015eeb Compare August 30, 2024 20:53
@bhufmann
Copy link
Contributor Author

bhufmann commented Sep 3, 2024

FYI @abhinava-ericsson

@@ -49,4 +52,16 @@ public interface ITmfConfigurationSourceType {
* @return A list of query parameter descriptors to be passed
*/
List<ITmfConfigParamDescriptor> getConfigParamDescriptors();
/**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing blank line before

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -49,4 +52,16 @@ public interface ITmfConfigurationSourceType {
* @return A list of query parameter descriptors to be passed
*/
List<ITmfConfigParamDescriptor> getConfigParamDescriptors();
/**
* A string containing a json-schema describing the query parameters
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gets a file containing...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. I added also a link to the schema spec.

* A string containing a json-schema describing the query parameters
* to be passed when creating a configuration instance of this type.
*
* Note: Use either {@link #getConfigParamDescriptors()} or {@link #getSchemaFile()}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the user, they don't know which is to be used. I would suggest:
Note: If the schema file is null, use {@link #getConfigParamDescriptors()} instead.

Should we also add a note in that other method?
Note: Use this method if {@link #getSchemaFile()} returns null.

For schema specification see https://json-schema.org/

[Added] support for json-schema file to TmfConfigurationSourceType

Signed-off-by: Bernd Hufmann <[email protected]>
@bhufmann bhufmann merged commit 9fb2174 into eclipse-tracecompass:master Oct 15, 2024
4 checks passed
@bhufmann bhufmann deleted the json-schema branch October 15, 2024 18:52
@bhufmann bhufmann mentioned this pull request Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants