This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit db1a7cae505454d5717bd5869e9f3d2c3a43a9cb Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 12:27:08 2022 -0400 doc-config-descriptions-edit storage --- kamelets/ftp-sink.kamelet.yaml | 4 ++-- kamelets/ftp-source.kamelet.yaml | 6 +++--- kamelets/ftps-sink.kamelet.yaml | 22 ++++++++++------------ kamelets/ftps-source.kamelet.yaml | 6 +++--- kamelets/minio-sink.kamelet.yaml | 18 ++++++++---------- kamelets/minio-source.kamelet.yaml | 14 +++++++------- kamelets/scp-sink.kamelet.yaml | 4 ++-- kamelets/sftp-sink.kamelet.yaml | 10 ++++------ kamelets/sftp-source.kamelet.yaml | 18 +++++++++--------- 9 files changed, 48 insertions(+), 54 deletions(-) diff --git a/kamelets/ftp-sink.kamelet.yaml b/kamelets/ftp-sink.kamelet.yaml index 1bbf4609..db9b5173 100644 --- a/kamelets/ftp-sink.kamelet.yaml +++ b/kamelets/ftp-sink.kamelet.yaml @@ -47,11 +47,11 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname of the FTP server + description: The hostname of the FTP server type: string connectionPort: title: Connection Port - description: Port of the FTP server + description: The port of the FTP server type: string default: 21 username: diff --git a/kamelets/ftp-source.kamelet.yaml b/kamelets/ftp-source.kamelet.yaml index 36bbcaa4..b5227a78 100644 --- a/kamelets/ftp-source.kamelet.yaml +++ b/kamelets/ftp-source.kamelet.yaml @@ -41,11 +41,11 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname of the FTP server + description: The hostname of the FTP server type: string connectionPort: title: Connection Port - description: Port of the FTP server + description: The port of the FTP server type: string default: 21 username: @@ -82,7 +82,7 @@ spec: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' idempotent: title: Idempotency - description: Skip already processed files. + description: Skip already-processed files. type: boolean default: true x-descriptors: diff --git a/kamelets/ftps-sink.kamelet.yaml b/kamelets/ftps-sink.kamelet.yaml index 998fcde4..6bf2044b 100644 --- a/kamelets/ftps-sink.kamelet.yaml +++ b/kamelets/ftps-sink.kamelet.yaml @@ -30,13 +30,11 @@ spec: definition: title: "FTPS Sink" description: |- - Send data to an FTPS Server. + Send data to an FTPS server. - The Kamelet expects the following headers to be set: + In the header, you can set the `file` / `ce-file` property to specify the filename to upload. - - `file` / `ce-file`: as the file name to upload - - If the header won't be set the exchange ID will be used as file name. + If you do not set the property in the header, the Kamelet uses the exchange ID for the filename. required: - connectionHost - connectionPort @@ -47,22 +45,22 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname of the FTP server + description: The hostname of the FTP server. type: string connectionPort: title: Connection Port - description: Port of the FTP server + description: The port of the FTP server. type: string default: 21 username: title: Username - description: The username to access the FTP server + description: The username to access the FTP server. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to access the FTP server + description: The password to access the FTP server. type: string format: password x-descriptors: @@ -70,18 +68,18 @@ spec: - urn:camel:group:credentials directoryName: title: Directory Name - description: The starting directory + description: The starting directory. type: string passiveMode: title: Passive Mode - description: Sets passive mode connection + description: Set the passive mode connection. type: boolean default: false x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' fileExist: title: File Existence - description: How to behave in case of file already existent. There are 4 enums and the value can be one of Override, Append, Fail or Ignore + description: Specifies how the Kamelet behaves if the file already exists. The value can be: Override, Append, Fail, or Ignore. type: string default: Override dependencies: diff --git a/kamelets/ftps-source.kamelet.yaml b/kamelets/ftps-source.kamelet.yaml index 5f7f8d1c..12c4d1d5 100644 --- a/kamelets/ftps-source.kamelet.yaml +++ b/kamelets/ftps-source.kamelet.yaml @@ -41,11 +41,11 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname of the FTPS server + description: The hostname of the FTPS server type: string connectionPort: title: Connection Port - description: Port of the FTPS server + description: The port of the FTPS server type: string default: 21 username: @@ -82,7 +82,7 @@ spec: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' idempotent: title: Idempotency - description: Skip already processed files. + description: Skip already-processed files. type: boolean default: true x-descriptors: diff --git a/kamelets/minio-sink.kamelet.yaml b/kamelets/minio-sink.kamelet.yaml index 16167dd1..16808505 100644 --- a/kamelets/minio-sink.kamelet.yaml +++ b/kamelets/minio-sink.kamelet.yaml @@ -30,13 +30,11 @@ spec: definition: title: "Minio Sink" description: |- - Upload data to Minio. + Upload data to MinIO. - The Kamelet expects the following headers to be set: + In the header, you can set the `file` / `ce-file` property to specify the filename to upload. - - `file` / `ce-file`: as the file name to upload - - If the header won't be set the exchange ID will be used as file name. + If you do not set the property in the header, the Kamelet uses the exchange ID for the filename. required: - bucketName - accessKey @@ -46,11 +44,11 @@ spec: properties: bucketName: title: Bucket Name - description: The Minio Bucket name + description: The Minio Bucket name. type: string accessKey: title: Access Key - description: The access key obtained from Minio + description: The access key obtained from MinIO. type: string format: password x-descriptors: @@ -58,7 +56,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from Minio + description: The secret key obtained from MinIO. type: string format: password x-descriptors: @@ -66,12 +64,12 @@ spec: - urn:camel:group:credentials endpoint: title: Endpoint - description: The Minio Endpoint, it can be an URL, domain name, IPv4 address or IPv6 address. + description: The MinIO Endpoint. You can specify an URL, domain name, IPv4 address, or IPv6 address. type: string example: http://localhost:9000 autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the Minio bucket bucketName. + description: Specify to automatically create the MinIO bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/minio-source.kamelet.yaml b/kamelets/minio-source.kamelet.yaml index 6874ed25..f5382903 100644 --- a/kamelets/minio-source.kamelet.yaml +++ b/kamelets/minio-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "Minio Source" description: |- - Receive data from Minio. + Receive data from MinIO. required: - bucketName - accessKey @@ -40,18 +40,18 @@ spec: properties: bucketName: title: Bucket Name - description: The Minio Bucket name + description: The MinIO Bucket name. type: string deleteAfterRead: title: Auto-delete Objects - description: Delete objects after consuming them + description: Delete objects after consuming them. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: true accessKey: title: Access Key - description: The access key obtained from Minio + description: The access key obtained from MinIO. type: string format: password x-descriptors: @@ -59,7 +59,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from Minio + description: The secret key obtained from MinIO. type: string format: password x-descriptors: @@ -67,12 +67,12 @@ spec: - urn:camel:group:credentials endpoint: title: Endpoint - description: The Minio Endpoint, it can be an URL, domain name, IPv4 address or IPv6 address. + description: The MinIO Endpoint. You can specify an URL, domain name, IPv4 address, or IPv6 address. type: string example: http://localhost:9000 autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the Minio bucket bucketName. + description: Specify to automatically create the MinIO bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/scp-sink.kamelet.yaml b/kamelets/scp-sink.kamelet.yaml index 01c883e1..798bec4f 100644 --- a/kamelets/scp-sink.kamelet.yaml +++ b/kamelets/scp-sink.kamelet.yaml @@ -39,11 +39,11 @@ spec: properties: serverName: title: Hostname - description: Hostname of the FTP server + description: The hostname of the FTP server type: string serverPort: title: Port - description: Port of the FTP server + description: The port of the FTP server type: string username: title: Username diff --git a/kamelets/sftp-sink.kamelet.yaml b/kamelets/sftp-sink.kamelet.yaml index a6525b78..af9f7f8e 100644 --- a/kamelets/sftp-sink.kamelet.yaml +++ b/kamelets/sftp-sink.kamelet.yaml @@ -32,11 +32,9 @@ spec: description: |- Send data to an SFTP Server. - The Kamelet expects the following headers to be set: + In the header, you can set the `file` / `ce-file` property to specify the filename to upload. - - `file` / `ce-file`: as the file name to upload - - If the header won't be set the exchange ID will be used as file name. + If you do not set the property in the header, the Kamelet uses the exchange ID for the filename. required: - connectionHost - connectionPort @@ -47,11 +45,11 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname of the FTP server + description: The hostname of the FTP server type: string connectionPort: title: Connection Port - description: Port of the FTP server + description: The port of the FTP server type: string default: 22 username: diff --git a/kamelets/sftp-source.kamelet.yaml b/kamelets/sftp-source.kamelet.yaml index 1a419d46..bb3efc5f 100644 --- a/kamelets/sftp-source.kamelet.yaml +++ b/kamelets/sftp-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "SFTP Source" description: |- - Receive data from an SFTP Server. + Receive data from an SFTP server. required: - connectionHost - connectionPort @@ -41,22 +41,22 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname of the SFTP server + description: The hostname of the SFTP server. type: string connectionPort: title: Connection Port - description: Port of the FTP server + description: The port of the FTP server. type: string default: 22 username: title: Username - description: The username to access the SFTP server + description: The username to access the SFTP server. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to access the SFTP server + description: The password to access the SFTP server. type: string format: password x-descriptors: @@ -64,25 +64,25 @@ spec: - urn:camel:group:credentials directoryName: title: Directory Name - description: The starting directory + description: The starting directory. type: string passiveMode: title: Passive Mode - description: Sets passive mode connection + description: Sets the passive mode connection. type: boolean default: false x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' recursive: title: Recursive - description: If a directory, will look for files in all the sub-directories as well. + description: If a directory, look for files in all sub-directories as well. type: boolean default: false x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' idempotent: title: Idempotency - description: Skip already processed files. + description: Skip already-processed files. type: boolean default: true x-descriptors:
