swagger: Specify list possible implementation of AxisDomain #220
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PatrickTasse
requested changes
Aug 27, 2025
| * serialization via {@code type} discriminator. | ||
| */ | ||
| @Schema(description = "Domain of values supported on a chart axis. Can be either categorical or numeric range.") | ||
| @Schema(description = "Domain of values supported on a chart axis. Can be either categorical or numeric range.", oneOf = { |
Contributor
There was a problem hiding this comment.
When I check the corresponding yaml, it looks like an infinite recursion of AxisDomain to oneOf.
Maybe we need that the XYAxisDescription refers to oneOf instead.
Also the example value is generic with "type" value "string", not one of the two possible values, but I'm not sure if that can be fixed?
Contributor
Author
There was a problem hiding this comment.
Good catch. I think it's not correct like that. I think, instead, I have to change the XYAxisDescription as below:
/**
* @return Optional domain of values that this axis can take.
*/
@JsonProperty("axisDomain")
@Schema(description = "Optional domain of values that this axis supports", requiredMode = RequiredMode.NOT_REQUIRED, oneOf = {
AxisDomainCategorical.class,
AxisDomainRange.class
})
@Nullable Object getAxisDomain();
bhufmann
force-pushed
the
fix_axis_domain_swagger
branch
from
084d55c to
40d66fb
Compare
The AxisDomain can be either categorical or numeric range. Signed-off-by: Bernd Hufmann <[email protected]>
bhufmann
force-pushed
the
fix_axis_domain_swagger
branch
from
40d66fb to
bef70c9
Compare
PatrickTasse
approved these changes
Aug 27, 2025
bhufmann
merged commit cd12f49
into
eclipse-tracecompass-incubator:master
2 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
Specify list possible implementation of AxisDomain in the swagger annotations. The AxisDomain can be either categorical or numeric range.
How to test
Generate the openapi.yaml as described here and verify that the oneOf list is present.
Follow-ups
Review checklist