fix(): deprecate the plugin (#97)

Author: fdelbrayelle

src/main/java/io/kestra/plugin/singer/AbstractPythonSinger.java

@@ -64,30 +64,30 @@ public abstract class AbstractPythonSinger extends Task {
     @Getter(AccessLevel.NONE)
     protected transient Path workingDirectory;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "The name of Singer state file stored in KV Store."
     )
     @NotNull
     @Builder.Default
     protected Property<String> stateName = Property.ofValue("singer-state");
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "Override default pip packages to use a specific version."
     )
     protected Property<List<String>> pipPackages;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "Override default singer command."
     )
     protected Property<String> command;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "Deprecated, use 'taskRunner' instead"
     )
     @PluginProperty
     private DockerOptions docker;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "The task runner to use.",
         description = "Task runners are provided by plugins, each have their own properties."
     )
@@ -96,7 +96,7 @@ public abstract class AbstractPythonSinger extends Task {
     @Valid
     private TaskRunner<?> taskRunner = Docker.instance();
 
-    @Schema(title = "The task runner container image, only used if the task runner is container-based.")
+    @Schema(deprecated = true,title = "The task runner container image, only used if the task runner is container-based.")
     @Builder.Default
     private Property<String> containerImage = Property.ofValue(DEFAULT_IMAGE);
 

src/main/java/io/kestra/plugin/singer/taps/AbstractPythonTap.java

@@ -43,7 +43,7 @@ public abstract class AbstractPythonTap extends AbstractPythonSinger implements
     @Getter(AccessLevel.NONE)
     protected transient Pair<File, OutputStream> rawSingerStream;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "The list of stream configurations"
     )
     @PluginProperty
@@ -180,14 +180,14 @@ private String tapCommand(RunContext runContext) throws IllegalVariableEvaluatio
     @Builder
     @Getter
     public static class Output implements io.kestra.core.models.tasks.Output {
-        @Schema(
+        @Schema(deprecated = true,
             title = "Raw singer streams",
             description = "Json multiline file with raw singer format that can be passed to a target"
         )
         @PluginProperty(additionalProperties = URI.class)
         private final URI raw;
 
-        @Schema(
+        @Schema(deprecated = true,
             title = "Counter of stream items"
         )
         private final Long count;

src/main/java/io/kestra/plugin/singer/taps/BigQuery.java

@@ -15,6 +15,7 @@
 import java.io.IOException;
 import java.time.Instant;
 import java.util.*;
+
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 
@@ -23,47 +24,48 @@
 @EqualsAndHashCode
 @Getter
 @NoArgsConstructor
-@Schema(
+@Schema(deprecated = true,
     title = "Fetch data from BigQuery with a Singer tap.",
     description = "Full documentation can be found on the [GitHub Repo](https://github.com/anelendata/tap-bigquery)."
 )
+@Deprecated(forRemoval = true, since = "0.24")
 public class BigQuery extends AbstractPythonTap implements RunnableTask<AbstractPythonTap.Output> {
-    @Schema(
+    @Schema(deprecated = true,
         title = "The JSON service account key as string."
     )
     protected Property<String> serviceAccount;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Array holding objects describing streams (tables) to extract, with `name`, `table`, `columns`, `datetime_key`, and `filters` keys."
     )
     @PluginProperty
     protected List<Stream> streams;
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "Limits the number of records returned in each stream, applied as a limit in the query."
     )
     private Property<Integer> limit;
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "When replicating incrementally, disable to only select records whose `datetime_key` is greater than the maximum value replicated in the last run, by excluding records whose timestamps match exactly.",
         description = "This could cause records to be missed that were created after the last run finished, but during the same second and with the same timestamp."
     )
     @Builder.Default
     private Property<Boolean> startAlwaysInclusive = Property.ofValue(true);
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "Determines how much historical data will be extracted.",
         description = "Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take."
     )
     @PluginProperty(dynamic = true)
     private Instant startDateTime;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "Date up to when historical data will be extracted."
     )
     @PluginProperty(dynamic = true)
@@ -131,7 +133,7 @@ public static class Stream {
         @JsonProperty("datetime_key")
         String datetimeKey;
 
-        @Schema(
+        @Schema(deprecated = true,
             title = "these are parsed in `WHERE` clause",
             description = "filters are optional but we strongly recommend using this over a large partitioned table to control the cost."
         )

src/main/java/io/kestra/plugin/singer/taps/BingAds.java

@@ -16,6 +16,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 
@@ -24,61 +25,62 @@
 @EqualsAndHashCode
 @Getter
 @NoArgsConstructor
-@Schema(
+@Schema(deprecated = true,
     title = "Fetch data from Bing Ads with a Singer tap.",
     description = "Full documentation can be found on the [GitHub Repo](https://github.com/singer-io/tap-bing-ads)."
 )
+@Deprecated(forRemoval = true, since = "0.24")
 public class BingAds extends AbstractPythonTap implements RunnableTask<AbstractPythonTap.Output> {
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your developer token for Bing Ads application."
     )
     @PluginProperty(dynamic = true)
     private String developerToken;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your OAuth Client ID."
     )
     @PluginProperty(dynamic = true)
     private String oauthClientId;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your OAuth Client Secret."
     )
     @PluginProperty(dynamic = true)
     private String oauthClientSecret;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "The Refresh Token generated through the OAuth flow run using your OAuth Client and your Developer Token."
     )
     @PluginProperty(dynamic = true)
     private String refreshToken;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your Customer ID."
     )
     @PluginProperty(dynamic = true)
     private String customerId;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your accounts IDs."
     )
     @PluginProperty(dynamic = true)
     private List<String> accountIds;
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "Determines how much historical data will be extracted.",
         description = "Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take."
     )

src/main/java/io/kestra/plugin/singer/taps/ChargeBee.java

@@ -19,6 +19,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 
@@ -27,22 +28,23 @@
 @EqualsAndHashCode
 @Getter
 @NoArgsConstructor
-@Schema(
+@Schema(deprecated = true,
     title = "Fetch data from a ChargeBee account with a Singer tap.",
     description = "Full documentation can be found on the [GitHub Repo](https://github.com/hotgluexyz/tap-chargebee)."
 )
+@Deprecated(forRemoval = true, since = "0.24")
 public class ChargeBee extends AbstractPythonTap implements RunnableTask<AbstractPythonTap.Output> {
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your API Key."
     )
     @PluginProperty(dynamic = true)
     private String apiKey;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your site URL.",
         description = "mostly in the form {site}.chargebee.com"
     )
@@ -51,14 +53,14 @@ public class ChargeBee extends AbstractPythonTap implements RunnableTask<Abstrac
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "The version of product catalog wanted."
     )
     @PluginProperty(dynamic = true)
     private final String productCatalog = "1.0";
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "Determines how much historical data will be extracted.",
         description = "Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take."
     )

src/main/java/io/kestra/plugin/singer/taps/ExchangeRateHost.java

@@ -15,6 +15,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 
@@ -23,28 +24,29 @@
 @EqualsAndHashCode
 @Getter
 @NoArgsConstructor
-@Schema(
+@Schema(deprecated = true,
     title = "Fetch data from an exchangerate.host API with a Singer tap.",
     description = "Full documentation can be found on the [GitHub Repo](https://github.com/anelendata/tap-exchangeratehost)."
 )
+@Deprecated(forRemoval = true, since = "0.24")
 public class ExchangeRateHost extends AbstractPythonTap implements RunnableTask<AbstractPythonTap.Output> {
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "The exchange rates currency used for conversion."
     )
     @PluginProperty(dynamic = true)
     @Builder.Default
     private final String base = "EUR";
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "Determines how much historical data will be extracted.",
         description = "Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take."
     )
     @PluginProperty(dynamic = true)
     private LocalDate startDate;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "Date up to when historical data will be extracted."
     )
     @PluginProperty(dynamic = true)

src/main/java/io/kestra/plugin/singer/taps/FacebookAds.java

@@ -16,6 +16,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 
@@ -24,43 +25,44 @@
 @EqualsAndHashCode
 @Getter
 @NoArgsConstructor
-@Schema(
+@Schema(deprecated = true,
     title = "Fetch data from Facebook Ads with a Singer tap.",
     description = "Full documentation can be found on the [GitHub Repo](https://github.com/singer-io/tap-facebook)."
 )
+@Deprecated(forRemoval = true, since = "0.24")
 public class FacebookAds extends AbstractPythonTap implements RunnableTask<AbstractPythonTap.Output> {
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "Your Facebook Ads Account ID."
     )
     @PluginProperty(dynamic = true)
     private String accountId;
 
     @NotNull
     @NotEmpty
-    @Schema(
+    @Schema(deprecated = true,
         title = "User Token generated by Facebook OAuth handshake."
     )
     @PluginProperty(dynamic = true)
     private String accessToken;
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "How many Days before the Start Date to fetch Ads Insights for."
     )
     @Builder.Default
     private final Property<Integer> insightsBufferDays = Property.ofValue(0);
 
     @NotNull
-    @Schema(
+    @Schema(deprecated = true,
         title = "Determines how much historical data will be extracted.",
         description = "Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take."
     )
     @PluginProperty(dynamic = true)
     private LocalDate startDate;
 
-    @Schema(
+    @Schema(deprecated = true,
         title = "Date up to when historical data will be extracted."
     )
     @PluginProperty(dynamic = true)