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 192b0951cfeffc406e7ef8a8ad5a4e1794af85ef Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 10:23:01 2022 -0400 doc-config-descriptions-edit nosql --- kamelets/cassandra-sink.kamelet.yaml | 20 ++++++++-------- kamelets/cassandra-source.kamelet.yaml | 18 +++++++-------- kamelets/elasticsearch-index-sink.kamelet.yaml | 32 +++++++++++++------------- kamelets/mongodb-sink.kamelet.yaml | 22 +++++++++--------- kamelets/mongodb-source.kamelet.yaml | 22 +++++++++--------- 5 files changed, 57 insertions(+), 57 deletions(-) diff --git a/kamelets/cassandra-sink.kamelet.yaml b/kamelets/cassandra-sink.kamelet.yaml index 19351b14..fbf4d36e 100644 --- a/kamelets/cassandra-sink.kamelet.yaml +++ b/kamelets/cassandra-sink.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Cassandra Sink" description: |- - Send data to a Cassandra Cluster. + Send data to an Apache Cassandra cluster. - This Kamelet expects the body as JSON Array. The content of the JSON Array will be used as input for the CQL Prepared Statement set in the query parameter. + This Kamelet expects JSON Array formatted data. The content of the JSON Array is used as input for the CQL Prepared Statement set in the query parameter. required: - connectionHost - connectionPort @@ -42,28 +42,28 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname(s) cassandra server(s). Multiple hosts can be separated by comma. + description: The hostname(s) for the Cassandra server(s). Use a comma to seperate multiple hostnames. type: string example: localhost connectionPort: title: Connection Port - description: Port number of cassandra server(s) + description: The port number(s) of the cassandra server(s). Use a comma to seperate multiple port numbers. type: string example: 9042 keyspace: title: Keyspace - description: Keyspace to use + description: The keyspace to use. type: string example: customers username: title: Username - description: The username to use for accessing a secured Cassandra Cluster + description: The username for accessing a secured Cassandra cluster. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured Cassandra Cluster + description: The password for accessing a secured Cassandra cluster. type: string format: password x-descriptors: @@ -71,19 +71,19 @@ spec: - urn:camel:group:credentials consistencyLevel: title: Consistency Level - description: Consistency level to use. The value can be one of ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE + 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. type: string default: ANY prepareStatements: title: Prepare Statements - description: Whether to use PreparedStatements or regular Statements as the query. + description: If true, specifies to use PreparedStatements as the query. If false, specifies to use regular Statements as the query. type: boolean default: true x-descriptors: - urn:alm:descriptor:com.tectonic.ui:checkbox query: title: Query - description: The query to execute against the Cassandra cluster table + description: The query to execute against the Cassandra cluster table. type: string types: in: diff --git a/kamelets/cassandra-source.kamelet.yaml b/kamelets/cassandra-source.kamelet.yaml index a6d85105..17466466 100644 --- a/kamelets/cassandra-source.kamelet.yaml +++ b/kamelets/cassandra-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "Cassandra Source" description: |- - Query a Cassandra cluster table. + Send a query to an Apache Cassandra cluster table. required: - connectionHost - connectionPort @@ -40,28 +40,28 @@ spec: properties: connectionHost: title: Connection Host - description: Hostname(s) cassandra server(s). Multiple hosts can be separated by comma. + description: The hostname(s) for the Cassandra server(s). Use a comma to seperate multiple hostnames. type: string example: localhost connectionPort: title: Connection Port - description: Port number of cassandra server(s) + description: The port number(s) of the cassandra server(s). Use a comma to seperate multiple port numbers. type: string example: 9042 keyspace: title: Keyspace - description: Keyspace to use + description: The keyspace to use. type: string example: customers username: title: Username - description: The username to use for accessing a secured Cassandra Cluster + description: The username for accessing a secured Cassandra cluster. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured Cassandra Cluster + description: The password for accessing a secured Cassandra cluster. type: string format: password x-descriptors: @@ -69,17 +69,17 @@ spec: - urn:camel:group:credentials resultStrategy: title: Result Strategy - description: The strategy to convert the result set of the query. Possible values are ALL, ONE, LIMIT_10, LIMIT_100... + description: The strategy to convert the result set of the query. Example values: ALL, ONE, LIMIT_10, or LIMIT_100. type: string default: ALL consistencyLevel: title: Consistency Level - description: Consistency level to use. The value can be one of ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE + 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. type: string default: QUORUM query: title: Query - description: The query to execute against the Cassandra cluster table + description: The query to execute against the Cassandra cluster table. type: string types: out: diff --git a/kamelets/elasticsearch-index-sink.kamelet.yaml b/kamelets/elasticsearch-index-sink.kamelet.yaml index 4e613c4e..edf376b2 100644 --- a/kamelets/elasticsearch-index-sink.kamelet.yaml +++ b/kamelets/elasticsearch-index-sink.kamelet.yaml @@ -30,17 +30,17 @@ spec: definition: title: "ElasticSearch Index Sink" description: |- - This sink stores documents into ElasticSearch. + Stores JSON-formatted data into ElasticSearch. - Input data must have JSON format according to the index used. - - - `indexId` / `ce-indexid`: as the index ID for Elasticsearch - - If the header won't be set the exchange ID will be used as index. - - - `indexName` / `ce-indexname`: as the index Name for Elasticsearch - - If the header won't be set the exchange ID will be used as index name. + The input data must be formatted in JSON according to the requirements of the index. + + The Kamelet checks for the following headers: + + - `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. required: - clusterName - hostAddresses @@ -48,13 +48,13 @@ spec: properties: user: title: Username - description: Username to connect to ElasticSearch. + description: The username to connect to ElasticSearch. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: Password to connect to ElasticSearch. + description: The password to connect to ElasticSearch. type: string format: password x-descriptors: @@ -62,24 +62,24 @@ spec: - urn:camel:group:credentials enableSSL: title: Enable SSL - description: Do we want to connect using SSL? + description: Specifies to connect by using SSL. type: boolean default: true x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' hostAddresses: title: Host Addresses - description: Comma separated list with ip:port formatted remote transport addresses to use. + description: A comma-separated list of remote transport addresses in `ip:port format`. type: string example: quickstart-es-http:9200 clusterName: title: ElasticSearch Cluster Name - description: Name of the cluster. + description: The name of the ElasticSearch cluster. type: string example: quickstart indexName: title: Index in ElasticSearch - description: The name of the index to act against. + description: The name of the ElasticSearch index. type: string example: data types: diff --git a/kamelets/mongodb-sink.kamelet.yaml b/kamelets/mongodb-sink.kamelet.yaml index 6f143866..b174ce8e 100644 --- a/kamelets/mongodb-sink.kamelet.yaml +++ b/kamelets/mongodb-sink.kamelet.yaml @@ -30,13 +30,13 @@ spec: definition: title: "MongoDB Sink" description: |- - Send documents to MongoDB. + Send data to MongoDB. - This Kamelet expects a JSON as body. + This Kamelet expects a JSON-formatted body. - Properties you can as headers: + You can set the following header: - `db-upsert` / `ce-dbupsert` If the database should create the element if it does not exist. Boolean value. + `db-upsert` / `ce-dbupsert`: A boolean value that specifies whether the database should create an element if it does not exist. required: - hosts - collection @@ -45,15 +45,15 @@ spec: properties: hosts: title: MongoDB Hosts - description: Comma separated list of MongoDB Host Addresses in host:port format. + description: A comma-separated list of MongoDB host addresses in `host:port` format. type: string collection: title: MongoDB Collection - description: Sets the name of the MongoDB collection to bind to this endpoint. + description: The name of the MongoDB collection to bind to this endpoint. type: string password: title: MongoDB Password - description: User password for accessing MongoDB. + description: A user password for accessing MongoDB. type: string format: password x-descriptors: @@ -61,21 +61,21 @@ spec: - urn:camel:group:credentials username: title: MongoDB Username - description: Username for accessing MongoDB. + description: A username for accessing MongoDB. type: string x-descriptors: - urn:camel:group:credentials database: title: MongoDB Database - description: Sets the name of the MongoDB database to target. + description: The name of the MongoDB database. type: string writeConcern: title: Write Concern - description: Configure the level of acknowledgment requested from MongoDB for write operations, possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, MAJORITY. + description: The level of acknowledgment requested from MongoDB for write operations. Possible values are: ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, or MAJORITY. type: string createCollection: title: Collection - description: Create collection during initialisation if it doesn't exist. + description: Create a collection during initialization if it doesn't exist. type: boolean default: false x-descriptors: diff --git a/kamelets/mongodb-source.kamelet.yaml b/kamelets/mongodb-source.kamelet.yaml index 57191fca..307d6fb5 100644 --- a/kamelets/mongodb-source.kamelet.yaml +++ b/kamelets/mongodb-source.kamelet.yaml @@ -30,13 +30,13 @@ spec: definition: title: "MongoDB Source" description: |- - Consume documents from MongoDB. + Consume data from MongoDB. - If the persistentTailTracking option will be enabled, the consumer will keep track of the last consumed message and on the next restart, the consumption will restart from that message. In case of persistentTailTracking enabled, the tailTrackIncreasingField must be provided (by default it is optional). + If you enable the `persistentTailTracking` property, the consumer keeps track of the last consumed message and, on the next restart, the consumption restarts from that message. If you enable `persistentTailTracking`, you must provide a value for the `tailTrackIncreasingField` property (by default it is optional). - If the persistentTailTracking option won't be enabled, the consumer will consume the whole collection and wait in idle for new documents to consume. + If you disable the `persistentTailTracking` property, the consumer consumes the whole collection and waits in idle for new data to consume. - The collection you're consuming from needs to be a capped collection. + The collection that provides the data must be a capped collection. required: - hosts - collection @@ -45,15 +45,15 @@ spec: properties: hosts: title: MongoDB Hosts - description: Comma separated list of MongoDB Host Addresses in host:port format. + description: A comma-separated list of MongoDB host addresses in `host:port` format. type: string collection: title: MongoDB Collection - description: Sets the name of the MongoDB collection to bind to this endpoint. + description: The name of the MongoDB collection to bind to this endpoint. type: string password: title: MongoDB Password - description: User password for accessing MongoDB. + description: The user password for accessing MongoDB. type: string format: password x-descriptors: @@ -61,24 +61,24 @@ spec: - urn:camel:group:credentials username: title: MongoDB Username - description: Username for accessing MongoDB. The username must be present in the MongoDB's authentication database (authenticationDatabase). By default, the MongoDB authenticationDatabase is 'admin'. + description: The username for accessing MongoDB. The username must be present in the MongoDB's authentication database (`authenticationDatabase`). By default, the MongoDB `authenticationDatabase` is 'admin'. type: string x-descriptors: - urn:camel:group:credentials database: title: MongoDB Database - description: Sets the name of the MongoDB database to target. + description: The name of the MongoDB database. type: string persistentTailTracking: title: MongoDB Persistent Tail Tracking - description: Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records. + description: Specifies to enable persistent tail tracking, which is a mechanism to keep track of the last consumed data across system restarts. The next time the system is up, the endpoint recovers the cursor from the point where it last stopped consuimg data. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false tailTrackIncreasingField: title: MongoDB Tail Track Increasing Field - description: Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. + description: The correlation field in the incoming data which is of increasing nature and is used to position the tailing cursor every time it is generated. type: string dependencies: - "camel:kamelet"
