Skip to content

Commit f4a30aa

Browse files
aj-emerichMalaydewangan09
authored andcommitted
docs(fs): update descriptions
1 parent 4e85858 commit f4a30aa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+271
-219
lines changed

src/main/java/io/kestra/plugin/fs/ftp/Delete.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
@Getter
2020
@NoArgsConstructor
2121
@Schema(
22-
title = "Delete a file from an FTP server."
22+
title = "Delete a remote FTP file",
23+
description = "Removes the specified file on the server. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home."
2324
)
2425
@Plugin(
2526
examples = {

src/main/java/io/kestra/plugin/fs/ftp/Download.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
@Getter
2121
@NoArgsConstructor
2222
@Schema(
23-
title = "Download file from an FTP server."
23+
title = "Download a file from FTP",
24+
description = "Fetches a single remote file to internal storage. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home."
2425
)
2526
@Plugin(
2627
examples = {

src/main/java/io/kestra/plugin/fs/ftp/Downloads.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
@Getter
2020
@NoArgsConstructor
2121
@Schema(
22-
title = "Download multiple files from an FTP server."
22+
title = "Download multiple files from FTP",
23+
description = "Lists matching files then downloads them to internal storage. Respects `maxFiles` (default 25) and optional post-download action (MOVE/DELETE). Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home."
2324
)
2425
@Plugin(
2526
examples = {

src/main/java/io/kestra/plugin/fs/ftp/FtpInterface.java

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
public interface FtpInterface {
1313
@Schema(
14-
title = "FTP proxy host"
14+
title = "FTP proxy hostname"
1515
)
1616
Property<String> getProxyHost();
1717

@@ -26,17 +26,20 @@ public interface FtpInterface {
2626
Property<Proxy.Type> getProxyType();
2727

2828
@Schema(
29-
title = "Is the path relative to the user's home directory"
29+
title = "Treat path as user home root",
30+
description = "If true (default), remote paths are resolved relative to the authenticated user's home directory."
3031
)
3132
Property<Boolean> getRootDir();
3233

3334
@Schema(
34-
title = "Whether to use a [passive mode](https://www.jscape.com/blog/active-v-s-passive-ftp-simplified). Passive mode is generally considered more secure as it's less likely to encounter issues with NAT and firewalls. Therefore, this property is by default set to `true`. To use active mode instead, set the property to `false`."
35+
title = "Use passive data connections",
36+
description = "Passive mode avoids most firewall and NAT issues and is enabled by default (`true`). Set to `false` to force active mode."
3537
)
3638
Property<Boolean> getPassiveMode();
3739

3840
@Schema(
39-
title = "Ensure the server IP responding matches the one that received the request."
41+
title = "Verify data channel IP",
42+
description = "Ensures the responding server IP matches the control connection to prevent spoofed data channels."
4043
)
4144
Property<Boolean> getRemoteIpVerification();
4245

@@ -47,33 +50,36 @@ public interface FtpInterface {
4750
@Jacksonized
4851
class Options {
4952
@Schema(
50-
title = "The timeout for the initial control connection."
53+
title = "Control connection timeout",
54+
description = "Maximum time to open the control channel. Default 30s."
5155
)
5256
@Builder.Default
5357
Property<Duration> connectionTimeout = Property.ofValue(Duration.ofSeconds(30));
5458

5559
@Schema(
56-
title = "The timeout for opening the data channel."
60+
title = "Data channel timeout",
61+
description = "Maximum time to open the data socket. Default 30s."
5762
)
5863
@Builder.Default
5964
Property<Duration> dataTimeout = Property.ofValue(Duration.ofSeconds(30));
6065

6166
@Schema(
62-
title = "The socket timeout."
67+
title = "Socket read timeout",
68+
description = "Timeout for socket reads and writes once connected. Default 30s."
6369
)
6470
@Builder.Default
6571
Property<Duration> socketTimeout = Property.ofValue(Duration.ofSeconds(30));
6672

6773
@Schema(
68-
title = "The control keep-alive timeout.",
69-
description = "Ensures the socket stays alive after downloading a large file."
74+
title = "Control keep-alive interval",
75+
description = "Sends keep-alive commands during long transfers. Default 30s."
7076
)
7177
@Builder.Default
7278
Property<Duration> controlKeepAliveTimeout = Property.ofValue(Duration.ofSeconds(30));
7379

7480
@Schema(
75-
title = "The control keep-alive reply timeout.",
76-
description = "Ensures the socket stays alive after downloading a large file."
81+
title = "Keep-alive reply timeout",
82+
description = "How long to wait for keep-alive responses before failing. Default 30s."
7783
)
7884
@Builder.Default
7985
Property<Duration> controlKeepAliveReplyTimeout = Property.ofValue(Duration.ofSeconds(30));

src/main/java/io/kestra/plugin/fs/ftp/List.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
@Getter
2020
@NoArgsConstructor
2121
@Schema(
22-
title = "List files from an FTP server directory."
22+
title = "List files in an FTP directory",
23+
description = "Lists entries under the given path with optional regexp filter. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home."
2324
)
2425
@Plugin(
2526
examples = {

src/main/java/io/kestra/plugin/fs/ftp/Move.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
@Getter
2020
@NoArgsConstructor
2121
@Schema(
22-
title = "Move a file to an FTP server.",
23-
description ="If the destination directory doesn't exist, it will be created"
22+
title = "Move or rename an FTP file",
23+
description = "Moves/renames a remote file; destination directories are created when missing. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home."
2424
)
2525
@Plugin(
2626
examples = {

src/main/java/io/kestra/plugin/fs/ftp/Trigger.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
@Getter
2020
@NoArgsConstructor
2121
@Schema(
22-
title = "Trigger a flow as soon as new files are detected in a given FTP server's directory."
22+
title = "Trigger on new FTP files",
23+
description = "Polls a remote directory on the interval and starts a Flow when new files appear. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home. Use `action` MOVE/DELETE to avoid reprocessing."
2324
)
2425
@Plugin(
2526
examples = {

src/main/java/io/kestra/plugin/fs/ftp/Upload.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
@Getter
2020
@NoArgsConstructor
2121
@Schema(
22-
title = "Upload a file to an FTP server."
22+
title = "Upload a file to FTP",
23+
description = "Pushes one local file to the remote path. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home."
2324
)
2425
@Plugin(
2526
examples = {

src/main/java/io/kestra/plugin/fs/ftp/Uploads.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
@Getter
2020
@NoArgsConstructor
2121
@Schema(
22-
title = "Upload files to an FTP server's directory."
22+
title = "Upload multiple files to FTP",
23+
description = "Uploads each provided file to the target directory. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home."
2324
)
2425
@Plugin(
2526
examples = {

src/main/java/io/kestra/plugin/fs/ftps/Delete.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
@Getter
2323
@NoArgsConstructor
2424
@Schema(
25-
title = "Delete a file from an FTPS server."
25+
title = "Delete a remote FTPS file",
26+
description = "Removes the specified file over FTPS. Defaults: port 990, EXPLICIT mode, PROT P data channel, passive mode on, remote IP verification on, paths relative to user home. `insecureTrustAllCertificates` skips SSL checks for testing."
2627
)
2728
@Plugin(
2829
examples = {

0 commit comments

Comments
 (0)