feat(core): Schema title annotation for Custom Dashboard Filter

kestra-io · Jan 21, 2025 · c337d55 · c337d55
1 parent f8b2056
commit c337d55
Show file tree

Hide file tree

Showing 22 changed files with 44 additions and 13 deletions.
diff --git a/core/src/main/java/io/kestra/core/models/dashboards/DataFilter.java b/core/src/main/java/io/kestra/core/models/dashboards/DataFilter.java
@@ -1,8 +1,13 @@
 package io.kestra.core.models.dashboards;
 
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
 import io.kestra.core.models.annotations.Plugin;
 import io.kestra.core.models.dashboards.filters.AbstractFilter;
 import io.kestra.core.repositories.QueryBuilderInterface;
+import io.kestra.plugin.core.dashboard.data.Executions;
+import io.kestra.plugin.core.dashboard.data.Logs;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Pattern;
@@ -22,12 +27,18 @@
 @NoArgsConstructor
 @Plugin
 @EqualsAndHashCode
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type", visible = true, include = JsonTypeInfo.As.EXISTING_PROPERTY)
+@JsonSubTypes({
+    @JsonSubTypes.Type(value = Executions.class, name = "io.kestra.plugin.core.dashboard.data.Executions"),
+    @JsonSubTypes.Type(value = Logs.class, name = "io.kestra.plugin.core.dashboard.data.Logs"),
+})
 public abstract class DataFilter<F extends Enum<F>, C extends ColumnDescriptor<F>> implements io.kestra.core.models.Plugin {
     @NotNull
     @NotBlank
     @Pattern(regexp = "\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*(\\.\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*)*")
     private String type;
 
+
     private Map<String, C> columns;
 
     @Setter

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/charts/DataChart.java b/core/src/main/java/io/kestra/core/models/dashboards/charts/DataChart.java
@@ -1,16 +1,10 @@
 package io.kestra.core.models.dashboards.charts;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonSubTypes;
-import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import io.kestra.core.models.annotations.Plugin;
 import io.kestra.core.models.dashboards.ChartOption;
 import io.kestra.core.models.dashboards.DataFilter;
 import io.kestra.core.validations.DataChartValidation;
-import io.kestra.plugin.core.dashboard.chart.Bar;
-import io.kestra.plugin.core.dashboard.chart.Pie;
-import io.kestra.plugin.core.dashboard.chart.Table;
-import io.kestra.plugin.core.dashboard.chart.TimeSeries;
 import jakarta.validation.constraints.NotNull;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -24,13 +18,6 @@
 @JsonInclude(JsonInclude.Include.NON_DEFAULT)
 @EqualsAndHashCode
 @DataChartValidation
-//@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
-//@JsonSubTypes({
-//    @JsonSubTypes.Type(value = Bar.class, name = "io.kestra.plugin.core.dashboard.chart.Bar"),
-//    @JsonSubTypes.Type(value = Pie.class, name = "io.kestra.plugin.core.dashboard.chart.Pie"),
-//    @JsonSubTypes.Type(value = Table.class, name = "io.kestra.plugin.core.dashboard.chart.Table"),
-//    @JsonSubTypes.Type(value = TimeSeries.class, name = "io.kestra.plugin.core.dashboard.chart.TimeSeries")
-//})
 public abstract class DataChart<P extends ChartOption, D extends DataFilter<?, ?>> extends Chart<P> implements io.kestra.core.models.Plugin {
     @NotNull
     private D data;

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/Contains.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/Contains.java
@@ -13,6 +13,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "CONTAINS")
 public class Contains<F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/EndsWith.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/EndsWith.java
@@ -1,6 +1,7 @@
 package io.kestra.core.models.dashboards.filters;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
@@ -12,6 +13,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "ENDS_WITH")
 public class EndsWith <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/EqualTo.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/EqualTo.java
@@ -15,6 +15,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "EQUAL_TO")
 public class EqualTo <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/GreaterThan.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/GreaterThan.java
@@ -15,6 +15,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "GREATER_THAN")
 public class GreaterThan <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/GreaterThanOrEqualTo.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/GreaterThanOrEqualTo.java
@@ -15,6 +15,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "GREATER_THAN_OR_EQUAL_TO")
 public class GreaterThanOrEqualTo <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/In.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/In.java
@@ -17,6 +17,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "IN")
 public class In <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/IsFalse.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/IsFalse.java
@@ -1,6 +1,7 @@
 package io.kestra.core.models.dashboards.filters;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
 import lombok.Getter;
@@ -10,6 +11,7 @@
 @SuperBuilder
 @Getter
 @NoArgsConstructor
+@Schema(title = "IS_FALSE")
 public class IsFalse <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/IsNotNull.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/IsNotNull.java
@@ -1,6 +1,7 @@
 package io.kestra.core.models.dashboards.filters;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
 import lombok.Getter;
@@ -10,6 +11,7 @@
 @SuperBuilder
 @Getter
 @NoArgsConstructor
+@Schema(title = "IS_NOT_NULL")
 public class IsNotNull <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/IsNull.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/IsNull.java
@@ -1,6 +1,7 @@
 package io.kestra.core.models.dashboards.filters;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
 import lombok.Getter;
@@ -10,6 +11,7 @@
 @SuperBuilder
 @Getter
 @NoArgsConstructor
+@Schema(title = "IS_NULL")
 public class IsNull <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/IsTrue.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/IsTrue.java
@@ -1,6 +1,7 @@
 package io.kestra.core.models.dashboards.filters;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
 import lombok.Getter;
@@ -10,6 +11,7 @@
 @SuperBuilder
 @Getter
 @NoArgsConstructor
+@Schema(title = "IS_TRUE")
 public class IsTrue <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/LessThan.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/LessThan.java
@@ -15,6 +15,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "LESS_THAN")
 public class LessThan <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/LessThanOrEqualTo.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/LessThanOrEqualTo.java
@@ -15,6 +15,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "LESS_THAN_OR_EQUAL_TO")
 public class LessThanOrEqualTo <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/NotEqualTo.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/NotEqualTo.java
@@ -15,6 +15,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "NOT_EQUAL_TO")
 public class NotEqualTo <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/NotIn.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/NotIn.java
@@ -17,6 +17,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "NOT_IN")
 public class NotIn <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/Or.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/Or.java
@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import io.kestra.core.validations.OrFilterValidation;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
@@ -17,6 +18,7 @@
 @NoArgsConstructor
 @EqualsAndHashCode
 @OrFilterValidation
+@Schema(title = "OR")
 public class Or <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/Regex.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/Regex.java
@@ -1,6 +1,7 @@
 package io.kestra.core.models.dashboards.filters;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
@@ -12,6 +13,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "REGEX")
 public class Regex <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/core/models/dashboards/filters/StartsWith.java b/core/src/main/java/io/kestra/core/models/dashboards/filters/StartsWith.java
@@ -1,6 +1,7 @@
 package io.kestra.core.models.dashboards.filters;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
@@ -12,6 +13,7 @@
 @Getter
 @NoArgsConstructor
 @EqualsAndHashCode
+@Schema(title = "STARTS_WITH")
 public class StartsWith <F extends Enum<F>> extends AbstractFilter<F> {
     @NotNull
     @JsonInclude

diff --git a/core/src/main/java/io/kestra/plugin/core/dashboard/data/Executions.java b/core/src/main/java/io/kestra/plugin/core/dashboard/data/Executions.java
@@ -1,6 +1,7 @@
 package io.kestra.plugin.core.dashboard.data;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonTypeName;
 import io.kestra.core.models.annotations.Plugin;
 import io.kestra.core.models.dashboards.ColumnDescriptor;
 import io.kestra.core.models.dashboards.DataFilter;
@@ -9,6 +10,7 @@
 import io.kestra.core.repositories.ExecutionRepositoryInterface;
 import io.kestra.core.repositories.QueryBuilderInterface;
 import io.kestra.core.validations.ExecutionsDataFilterValidation;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -24,6 +26,8 @@
 @JsonInclude(JsonInclude.Include.NON_DEFAULT)
 @EqualsAndHashCode
 @ExecutionsDataFilterValidation
+@Schema(title = "Executions")
+@JsonTypeName("Executions")
 public class Executions<C extends ColumnDescriptor<Executions.Fields>> extends DataFilter<Executions.Fields, C> {
     @Override
     public Class<? extends QueryBuilderInterface<Executions.Fields>> repositoryClass() {

diff --git a/core/src/main/java/io/kestra/plugin/core/dashboard/data/Logs.java b/core/src/main/java/io/kestra/plugin/core/dashboard/data/Logs.java
@@ -11,6 +11,7 @@
 import io.kestra.core.models.dashboards.filters.LessThanOrEqualTo;
 import io.kestra.core.repositories.LogRepositoryInterface;
 import io.kestra.core.repositories.QueryBuilderInterface;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -26,6 +27,7 @@
 @Plugin
 @JsonInclude(JsonInclude.Include.NON_DEFAULT)
 @EqualsAndHashCode
+@Schema(title = "Logs")
 public class Logs<C extends ColumnDescriptor<Logs.Fields>> extends DataFilter<Logs.Fields, C> {
     @Override
     public Class<? extends QueryBuilderInterface<Logs.Fields>> repositoryClass() {

diff --git a/core/src/main/java/io/kestra/plugin/core/dashboard/data/Metrics.java b/core/src/main/java/io/kestra/plugin/core/dashboard/data/Metrics.java
@@ -9,6 +9,7 @@
 import io.kestra.core.models.dashboards.filters.EqualTo;
 import io.kestra.core.repositories.MetricRepositoryInterface;
 import io.kestra.core.repositories.QueryBuilderInterface;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -23,6 +24,7 @@
 @Plugin
 @JsonInclude(JsonInclude.Include.NON_DEFAULT)
 @EqualsAndHashCode
+@Schema(title = "Metrics")
 public class Metrics<C extends ColumnDescriptor<Metrics.Fields>> extends DataFilter<Metrics.Fields, C> {
     @Override
     public Class<? extends QueryBuilderInterface<Metrics.Fields>> repositoryClass() {