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 789a2f218b2f49852fbde3286f38912e22112a7d Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 19:05:44 2022 -0400 doc-config-descriptions-edit review-all --- kamelets/aws-ddb-sink.kamelet.yaml | 2 +- kamelets/aws-s3-source.kamelet.yaml | 1 - kamelets/azure-eventhubs-sink.kamelet.yaml | 2 +- kamelets/azure-storage-blob-sink.kamelet.yaml | 2 +- kamelets/azure-storage-queue-sink.kamelet.yaml | 5 +---- kamelets/cassandra-sink.kamelet.yaml | 4 ++-- kamelets/cassandra-source.kamelet.yaml | 8 ++++---- kamelets/elasticsearch-index-sink.kamelet.yaml | 8 ++++---- kamelets/ftp-sink.kamelet.yaml | 24 +++++++++++------------- kamelets/ftp-source.kamelet.yaml | 14 +++++++------- kamelets/ftps-source.kamelet.yaml | 16 ++++++++-------- kamelets/google-storage-sink.kamelet.yaml | 6 ++---- kamelets/jms-amqp-10-source.kamelet.yaml | 2 +- kamelets/mariadb-sink.kamelet.yaml | 2 +- kamelets/mariadb-source.kamelet.yaml | 10 +++++----- kamelets/minio-source.kamelet.yaml | 2 +- kamelets/mongodb-sink.kamelet.yaml | 6 ++---- kamelets/mysql-source.kamelet.yaml | 2 +- kamelets/oracle-database-sink.kamelet.yaml | 2 +- kamelets/oracle-database-source.kamelet.yaml | 2 +- kamelets/salesforce-create-sink.kamelet.yaml | 4 ++-- kamelets/salesforce-update-sink.kamelet.yaml | 2 +- kamelets/sftp-sink.kamelet.yaml | 10 +++++----- kamelets/sqlserver-sink.kamelet.yaml | 8 ++++---- 24 files changed, 67 insertions(+), 77 deletions(-) diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index c8cec8e3..997be2e1 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -77,7 +77,7 @@ spec: example: PutItem writeCapacity: title: Write Capacity - description: The provisioned throughput to reserve for writing resources to your table + description: The provisioned throughput to reserve for writing resources to your table. type: integer default: 1 useDefaultCredentialsProvider: diff --git a/kamelets/aws-s3-source.kamelet.yaml b/kamelets/aws-s3-source.kamelet.yaml index 41c47cba..60e1d06e 100644 --- a/kamelets/aws-s3-source.kamelet.yaml +++ b/kamelets/aws-s3-source.kamelet.yaml @@ -67,7 +67,6 @@ spec: includeBody: title: Include Body description: If true, the exchange is consumed and put into the body and closed. If false, the S3Object stream is put raw into the body and the headers are set with the S3 object metadata. - "type" : "boolean", type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/azure-eventhubs-sink.kamelet.yaml b/kamelets/azure-eventhubs-sink.kamelet.yaml index 3ba7422a..4873fa28 100644 --- a/kamelets/azure-eventhubs-sink.kamelet.yaml +++ b/kamelets/azure-eventhubs-sink.kamelet.yaml @@ -49,7 +49,7 @@ spec: type: string eventhubName: title: Eventhubs Name - description: The Event Hub name + description: The Event Hub name. type: string sharedAccessName: title: Share Access Name diff --git a/kamelets/azure-storage-blob-sink.kamelet.yaml b/kamelets/azure-storage-blob-sink.kamelet.yaml index 85df8d21..aad130be 100644 --- a/kamelets/azure-storage-blob-sink.kamelet.yaml +++ b/kamelets/azure-storage-blob-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Upload data to Azure Storage Blob. - The Kamelet expects the `file` / `ce-file` header to specify the file name to upload. If the header is not set, then the Kamelet uses the exchange ID as file name. + In the header, you can set the `file` / `ce-file` property to specify the filename to upload. If you do set property in the header, the Kamelet uses the exchange ID as filename. required: - accountName - containerName diff --git a/kamelets/azure-storage-queue-sink.kamelet.yaml b/kamelets/azure-storage-queue-sink.kamelet.yaml index c309fd79..004d8259 100644 --- a/kamelets/azure-storage-queue-sink.kamelet.yaml +++ b/kamelets/azure-storage-queue-sink.kamelet.yaml @@ -33,10 +33,7 @@ spec: description: |- Send events to Azure Storage queues. - The Kamelet checks for the `partition` / `ce-partition` header to determine how long an event remains in the Azure Storage queue. - Use `PnDTnHnMn.nS.` format. For example, `PT20.345S` parses as 20.345 seconds and `P2D` parses as 2 days. - - A header is optional. If the header is not set, the default of `P27D` (7 days) is used. + In the header, you can set the `partition` / `ce-partition` property to determine how long an event remains in the Azure Storage queue. Use `PnDTnHnMn.nS.` format. For example, `PT20.345S` parses as 20.345 seconds and `P2D` parses as 2 days. If you not set the property in the header, the Kamelet uses the default of `P27D` (7 days). required: - accountName - queueName diff --git a/kamelets/cassandra-sink.kamelet.yaml b/kamelets/cassandra-sink.kamelet.yaml index fbf4d36e..19bbb5a4 100644 --- a/kamelets/cassandra-sink.kamelet.yaml +++ b/kamelets/cassandra-sink.kamelet.yaml @@ -42,12 +42,12 @@ spec: properties: connectionHost: title: Connection Host - description: The hostname(s) for the Cassandra server(s). Use a comma to seperate multiple hostnames. + description: The hostname(s) for the Cassandra server(s). Use a comma to separate multiple hostnames. type: string example: localhost connectionPort: title: Connection Port - description: The port number(s) of the cassandra server(s). Use a comma to seperate multiple port numbers. + description: The port number(s) of the cassandra server(s). Use a comma to separate multiple port numbers. type: string example: 9042 keyspace: diff --git a/kamelets/cassandra-source.kamelet.yaml b/kamelets/cassandra-source.kamelet.yaml index 17466466..b2662ad4 100644 --- a/kamelets/cassandra-source.kamelet.yaml +++ b/kamelets/cassandra-source.kamelet.yaml @@ -40,12 +40,12 @@ spec: properties: connectionHost: title: Connection Host - description: The hostname(s) for the Cassandra server(s). Use a comma to seperate multiple hostnames. + description: The hostname(s) for the Cassandra server(s). Use a comma to separate multiple hostnames. type: string example: localhost connectionPort: title: Connection Port - description: The port number(s) of the cassandra server(s). Use a comma to seperate multiple port numbers. + description: The port number(s) of the cassandra server(s). Use a comma to separate multiple port numbers. type: string example: 9042 keyspace: @@ -69,12 +69,12 @@ spec: - urn:camel:group:credentials resultStrategy: title: Result Strategy - description: The strategy to convert the result set of the query. Example values: ALL, ONE, LIMIT_10, or LIMIT_100. + description: The strategy to convert the result set of the query. Possible values: ALL, ONE, LIMIT_10, or LIMIT_100. type: string default: ALL consistencyLevel: title: Consistency Level - description: The consistency level to use. Set the value to one of these options: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, or LOCAL_ONE. + description: The consistency level to use. Possible values: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, or LOCAL_ONE. type: string default: QUORUM query: diff --git a/kamelets/elasticsearch-index-sink.kamelet.yaml b/kamelets/elasticsearch-index-sink.kamelet.yaml index edf376b2..2fb0f137 100644 --- a/kamelets/elasticsearch-index-sink.kamelet.yaml +++ b/kamelets/elasticsearch-index-sink.kamelet.yaml @@ -33,14 +33,14 @@ spec: Stores JSON-formatted data into ElasticSearch. The input data must be formatted in JSON according to the requirements of the index. - - The Kamelet checks for the following headers: - + + In the header, you can set the following properties: + - `indexId` / `ce-indexid`: The index ID for ElasticSearch. - `indexName` / `ce-indexname`: The index name for ElasticSearch. - A header is optional. If a header is not set, the Kamelet uses the exchange ID as the index setting. + If you do not set a property in the header, the Kamelet uses the exchange ID for the index setting. required: - clusterName - hostAddresses diff --git a/kamelets/ftp-sink.kamelet.yaml b/kamelets/ftp-sink.kamelet.yaml index db9b5173..1f1c4a98 100644 --- a/kamelets/ftp-sink.kamelet.yaml +++ b/kamelets/ftp-sink.kamelet.yaml @@ -30,13 +30,11 @@ spec: definition: title: "FTP Sink" description: |- - Send data to an FTP Server. + Send data to an FTP server. + + In the header, you can set the `file` / `ce-file` property to specify the filename to upload. - The Kamelet expects the following headers to be set: - - - `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: The hostname of the FTP server + description: The hostname of the FTP server. type: string connectionPort: title: Connection Port - description: The 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: Specifies to use 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: How to behave in case of file already existent. There are 4 enums. Possible values: Override, Append, Fail, or Ignore. type: string default: Override dependencies: diff --git a/kamelets/ftp-source.kamelet.yaml b/kamelets/ftp-source.kamelet.yaml index b5227a78..1e4d1499 100644 --- a/kamelets/ftp-source.kamelet.yaml +++ b/kamelets/ftp-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "FTP Source" description: |- - Receive data from an FTP Server. + Receive data from an FTP server. required: - connectionHost - connectionPort @@ -41,22 +41,22 @@ spec: properties: connectionHost: title: Connection Host - description: The hostname of the FTP server + description: The hostname of the FTP server. type: string connectionPort: title: Connection Port - description: The 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: @@ -68,14 +68,14 @@ spec: type: string passiveMode: title: Passive Mode - description: Sets passive mode connection + description: Specifes to use 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 the sub-directories as well. type: boolean default: false x-descriptors: diff --git a/kamelets/ftps-source.kamelet.yaml b/kamelets/ftps-source.kamelet.yaml index 12c4d1d5..f121ee94 100644 --- a/kamelets/ftps-source.kamelet.yaml +++ b/kamelets/ftps-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "FTPS Source" description: |- - Receive data from an FTPS Server. + Receive data from an FTPS server. required: - connectionHost - connectionPort @@ -41,22 +41,22 @@ spec: properties: connectionHost: title: Connection Host - description: The hostname of the FTPS server + description: The hostname of the FTPS server. type: string connectionPort: title: Connection Port - description: The port of the FTPS server + description: The port of the FTPS server. type: string default: 21 username: title: Username - description: The username to access the FTPS server + description: The username to access the FTPS server. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to access the FTPS server + description: The password to access the FTPS server. type: string format: password x-descriptors: @@ -64,18 +64,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: Specifies to use 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: diff --git a/kamelets/google-storage-sink.kamelet.yaml b/kamelets/google-storage-sink.kamelet.yaml index d4ab0169..8964be6f 100644 --- a/kamelets/google-storage-sink.kamelet.yaml +++ b/kamelets/google-storage-sink.kamelet.yaml @@ -33,10 +33,8 @@ spec: Upload objects to Google Cloud Storage. You must encode the `serviceAccountKey` property before you pass it as a parameter. - - The Kamelet checks for the `file` / `ce-file` header got the name of the file to upload. - - A header is optional. If the header is not set, the exchange ID value is used as the file name. + + In the header, you can set the `file` / `ce-file` property to specify the filename to upload. If you do set property in the header, the Kamelet uses the exchange ID as filename. required: - bucketNameOrArn - serviceAccountKey diff --git a/kamelets/jms-amqp-10-source.kamelet.yaml b/kamelets/jms-amqp-10-source.kamelet.yaml index abaf9e23..98adc794 100644 --- a/kamelets/jms-amqp-10-source.kamelet.yaml +++ b/kamelets/jms-amqp-10-source.kamelet.yaml @@ -30,7 +30,7 @@ metadata: spec: definition: title: "JMS - AMQP 1.0 Kamelet Source" - description: "Consume data from any AMQP 1.0 compliant message broker by using the Apache." + description: "Consume data from any AMQP 1.0 compliant message broker by using the Apache Qpid JMS client. required: - destinationName - remoteURI diff --git a/kamelets/mariadb-sink.kamelet.yaml b/kamelets/mariadb-sink.kamelet.yaml index 5933567c..18e8c5bd 100644 --- a/kamelets/mariadb-sink.kamelet.yaml +++ b/kamelets/mariadb-sink.kamelet.yaml @@ -82,7 +82,7 @@ spec: example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The name of the MariaDB Database Name. + description: The name of the MariaDB Database. type: string types: in: diff --git a/kamelets/mariadb-source.kamelet.yaml b/kamelets/mariadb-source.kamelet.yaml index 44ff33db..7a388129 100644 --- a/kamelets/mariadb-source.kamelet.yaml +++ b/kamelets/mariadb-source.kamelet.yaml @@ -55,13 +55,13 @@ spec: default: 3306 username: title: Username - description: The username to access a secured MariaDB Database + description: The username to access a secured MariaDB Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to access a secured MariaDB Database + description: The password to access a secured MariaDB Database. type: string format: password x-descriptors: @@ -69,16 +69,16 @@ spec: - urn:camel:group:credentials query: title: Query - description: The query to execute against the MariaDB Database + description: The query to execute against the MariaDB Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The name of the Database. + description: The name of the MariaDB Database. type: string consumedQuery: title: Consumed Query - description: A query to run on a tuple consumed + description: A query to run on a tuple consumed. type: string example: 'DELETE FROM accounts where user_id = :#user_id' types: diff --git a/kamelets/minio-source.kamelet.yaml b/kamelets/minio-source.kamelet.yaml index f5382903..a96d4231 100644 --- a/kamelets/minio-source.kamelet.yaml +++ b/kamelets/minio-source.kamelet.yaml @@ -72,7 +72,7 @@ spec: example: http://localhost:9000 autoCreateBucket: title: Autocreate Bucket - description: Specify to automatically create the MinIO bucket. + description: Specifies to automatically create the MinIO bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/mongodb-sink.kamelet.yaml b/kamelets/mongodb-sink.kamelet.yaml index b174ce8e..7bce443f 100644 --- a/kamelets/mongodb-sink.kamelet.yaml +++ b/kamelets/mongodb-sink.kamelet.yaml @@ -34,9 +34,7 @@ spec: This Kamelet expects a JSON-formatted body. - You can set the following header: - - `db-upsert` / `ce-dbupsert`: A boolean value that specifies whether the database should create an element if it does not exist. + In the header, you can set the `db-upsert` / `ce-dbupsert` property, a boolean value that specifies whether the database should create an element if it does not exist. required: - hosts - collection @@ -71,7 +69,7 @@ spec: type: string writeConcern: title: Write Concern - description: The level of acknowledgment requested from MongoDB for write operations. Possible values are: ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, or MAJORITY. + description: The level of acknowledgment requested from MongoDB for write operations. Possible values: ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, or MAJORITY. type: string createCollection: title: Collection diff --git a/kamelets/mysql-source.kamelet.yaml b/kamelets/mysql-source.kamelet.yaml index ed15de40..38ae947a 100644 --- a/kamelets/mysql-source.kamelet.yaml +++ b/kamelets/mysql-source.kamelet.yaml @@ -55,7 +55,7 @@ spec: default: 3306 username: title: Username - description: The username to access a secured MySQL Database + description: The username to access a secured MySQL Database. type: string x-descriptors: - urn:camel:group:credentials diff --git a/kamelets/oracle-database-sink.kamelet.yaml b/kamelets/oracle-database-sink.kamelet.yaml index f8bb0e41..f4130adf 100644 --- a/kamelets/oracle-database-sink.kamelet.yaml +++ b/kamelets/oracle-database-sink.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "Oracle Database Sink" description: |- - Send data to a Oracle Database. + Send data to an Oracle Database. In your KameletBinding file, you must explicitly declare the Oracle Database driver dependency in spec->integration->dependencies. diff --git a/kamelets/oracle-database-source.kamelet.yaml b/kamelets/oracle-database-source.kamelet.yaml index 0ea6fcbe..2b24c50b 100644 --- a/kamelets/oracle-database-source.kamelet.yaml +++ b/kamelets/oracle-database-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "Oracle Database Source" description: |- - Query data from a Oracle Database. + Query data from an Oracle Database. In your KameletBinding file, you must explicitly declare the Oracle Database driver dependency in spec->integration->dependencies. diff --git a/kamelets/salesforce-create-sink.kamelet.yaml b/kamelets/salesforce-create-sink.kamelet.yaml index 2abff764..d41e9120 100644 --- a/kamelets/salesforce-create-sink.kamelet.yaml +++ b/kamelets/salesforce-create-sink.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Salesforce Create Sink" description: |- - Creates an object in Salesforce. + Create an object in Salesforce. - The body of the message must contain the JSON of the Salesforce object. For example: `{ "Phone": "555", "Name": "Antonia", "LastName": "Garcia" }`. + The body of the message must contain the JSON of the Salesforce object, for example: `{ "Phone": "555", "Name": "Antonia", "LastName": "Garcia" }`. required: - clientId - clientSecret diff --git a/kamelets/salesforce-update-sink.kamelet.yaml b/kamelets/salesforce-update-sink.kamelet.yaml index 164019af..83db0abb 100644 --- a/kamelets/salesforce-update-sink.kamelet.yaml +++ b/kamelets/salesforce-update-sink.kamelet.yaml @@ -32,7 +32,7 @@ spec: description: |- Update an object in Salesforce. - The body received must contain a JSON key-value pair for each property to update. For example: `{ "Phone": "1234567890", "Name": "Antonia" }` + The body received must contain a JSON key-value pair for each property to update, for example: `{ "Phone": "1234567890", "Name": "Antonia" }` The body received must include the `sObjectName` and `sObjectId` properties. diff --git a/kamelets/sftp-sink.kamelet.yaml b/kamelets/sftp-sink.kamelet.yaml index af9f7f8e..95055298 100644 --- a/kamelets/sftp-sink.kamelet.yaml +++ b/kamelets/sftp-sink.kamelet.yaml @@ -54,13 +54,13 @@ spec: default: 22 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: @@ -68,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: Specifies to use 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: How to behave in case of file already existent. There are 4 enums. Possible values: Override, Append, Fail, or Ignore type: string default: Override dependencies: diff --git a/kamelets/sqlserver-sink.kamelet.yaml b/kamelets/sqlserver-sink.kamelet.yaml index 0e3a2ea0..31706051 100644 --- a/kamelets/sqlserver-sink.kamelet.yaml +++ b/kamelets/sqlserver-sink.kamelet.yaml @@ -63,13 +63,13 @@ spec: default: 1433 username: title: Username - description: The username to access a secured SQL Server Database + description: The username to access a secured SQL Server Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to access a secured SQL Server Database + description: The password to access a secured SQL Server Database. type: string format: password x-descriptors: @@ -77,12 +77,12 @@ spec: - urn:camel:group:credentials query: title: Query - description: The query to execute against the SQL Server Database + description: The query to execute against the SQL Server Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The name of the Database. + description: The name of the SQL Server Database. type: string types: in:
