Skip to content

swagger: Specify list possible implementation of AxisDomain #220

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.

Sign up for GitHub

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

Merged
bhufmann merged 1 commit into from
Aug 27, 2025
Merged

swagger: Specify list possible implementation of AxisDomain #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...compass/incubator/internal/trace/server/jersey/rest/core/model/AxisDomainCategorical.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
* <p>
* Used in Swagger schema generation for chart axis descriptions.
*/
@Schema(description = "Domain of values supported on a categorical chart axis.")
public class AxisDomainCategorical implements AxisDomain {

private final @NonNull Set<String> categories;
Expand All @@ -46,9 +47,9 @@ public AxisDomainCategorical(
}

@Override
@Schema(description = "Type of axis domain", requiredMode = RequiredMode.REQUIRED)
@Schema(description = "Type of axis domain: 'categorical'", requiredMode = RequiredMode.REQUIRED)
public String getType() {
return "categorical";
return "categorical"; //$NON-NLS-1$
}

/**
Expand Down
5 changes: 3 additions & 2 deletions .../tracecompass/incubator/internal/trace/server/jersey/rest/core/model/AxisDomainRange.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
* <p>
* Used in Swagger schema generation for chart axis descriptions.
*/
@Schema(description = "Domain of values supported on a numberical range chart axis.")
public class AxisDomainRange implements AxisDomain {

private final long start;
Expand All @@ -45,9 +46,9 @@ public AxisDomainRange(
}

@Override
@Schema(description = "Type of axis domain", requiredMode = RequiredMode.REQUIRED)
@Schema(description = "Type of axis domain: 'range'", requiredMode = RequiredMode.REQUIRED)
public String getType() {
return "range";
return "range"; //$NON-NLS-1$
}

/**
Expand Down
7 changes: 5 additions & 2 deletions ...racecompass/incubator/internal/trace/server/jersey/rest/core/model/XYAxisDescription.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ public interface XYAxisDescription {
* @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)
@Nullable AxisDomain getAxisDomain();
@Schema(description = "Optional domain of values that this axis supports", requiredMode = RequiredMode.NOT_REQUIRED, oneOf = {
AxisDomainCategorical.class,
AxisDomainRange.class
})
@Nullable Object getAxisDomain();
}
Loading