From a7f9ccc89ce3298c8f1586cc68226f77e82939a5 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 10:18:20 -0400 Subject: [PATCH 01/17] doc-config-descriptions-edit azure --- kamelets/azure-eventhubs-sink.kamelet.yaml | 18 ++++++++---------- kamelets/azure-eventhubs-source.kamelet.yaml | 16 ++++++++-------- ...storage-blob-changefeed-source.kamelet.yaml | 4 ++-- kamelets/azure-storage-blob-sink.kamelet.yaml | 8 ++------ .../azure-storage-blob-source.kamelet.yaml | 6 +++--- kamelets/azure-storage-queue-sink.kamelet.yaml | 13 +++++-------- .../azure-storage-queue-source.kamelet.yaml | 6 +++--- 7 files changed, 31 insertions(+), 40 deletions(-) diff --git a/kamelets/azure-eventhubs-sink.kamelet.yaml b/kamelets/azure-eventhubs-sink.kamelet.yaml index f64a51232..3ba7422aa 100644 --- a/kamelets/azure-eventhubs-sink.kamelet.yaml +++ b/kamelets/azure-eventhubs-sink.kamelet.yaml @@ -31,13 +31,11 @@ spec: definition: title: "Azure Eventhubs Sink" description: |- - Send Events to Azure Eventhubs. + Send events to Azure Event Hubs. - The Kamelet is able to understand the following headers to be set: - - - `partition` / `ce-partition`: as the time to live of the message in the queue. - - If the header won't be set then the partition will be assigned by Eventhubs + 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 partition is assigned by Event Hubs. required: - namespaceName - eventhubName @@ -47,21 +45,21 @@ spec: properties: namespaceName: title: Eventhubs Namespace - description: The eventhubs namespace + description: The Event Hubs namespace. type: string eventhubName: title: Eventhubs Name - description: The eventhub name + description: The Event Hub name type: string sharedAccessName: title: Share Access Name - description: EventHubs SAS key name + description: The Event Hubs SAS key name. type: string x-descriptors: - urn:camel:group:credentials sharedAccessKey: title: Share Access Key - description: The key for EventHubs SAS key name + description: The key for the Event Hubs SAS key name. type: string format: password x-descriptors: diff --git a/kamelets/azure-eventhubs-source.kamelet.yaml b/kamelets/azure-eventhubs-source.kamelet.yaml index 13ff4c4e1..951046b21 100644 --- a/kamelets/azure-eventhubs-source.kamelet.yaml +++ b/kamelets/azure-eventhubs-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Eventhubs Source" description: |- - Receive events from Azure Eventhubs. + Receive events from Azure Event Hubs. required: - namespaceName - eventhubName @@ -44,21 +44,21 @@ spec: properties: namespaceName: title: Eventhubs Namespace - description: The eventhubs namespace + description: The Event Hubs namespace. type: string eventhubName: title: Eventhubs Name - description: The eventhub name + description: The Event Hub name. type: string sharedAccessName: title: Share Access Name - description: EventHubs SAS key name + description: The Event Hubs SAS key name. type: string x-descriptors: - urn:camel:group:credentials sharedAccessKey: title: Share Access Key - description: The key for EventHubs SAS key name + description: The key for the Event Hubs SAS key name. type: string format: password x-descriptors: @@ -66,15 +66,15 @@ spec: - urn:camel:group:credentials blobAccountName: title: Azure Storage Blob Account Name - description: The name of the storage blob account to be use + description: The name of the Storage Blob account. type: string blobContainerName: title: Azure Storage Blob Container Name - description: The name of the storage blob container to be use + description: The name of the Storage Blob container. type: string blobAccessKey: title: Azure Storage Blob Access Key - description: The key for Azure Storage Blob service associated with the Blob account name + description: The key for the Azure Storage Blob service that is associated with the Storage Blob account name. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml b/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml index 17e2bf9de..5dcf1d519 100644 --- a/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml +++ b/kamelets/azure-storage-blob-changefeed-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Storage Blob Changefeed Source" description: |- - Consume Events from Azure Storage Blob Change feed. + Consume events from an Azure Storage Blob change feed. required: - period - accountName @@ -40,7 +40,7 @@ spec: properties: period: title: Period between Polls - description: The interval between fetches to the Azure Storage Changefeed in milliseconds + description: The interval (in milliseconds) between fetches to the Azure Storage change feed. type: integer default: 10000 accountName: diff --git a/kamelets/azure-storage-blob-sink.kamelet.yaml b/kamelets/azure-storage-blob-sink.kamelet.yaml index 9421ab832..85df8d211 100644 --- a/kamelets/azure-storage-blob-sink.kamelet.yaml +++ b/kamelets/azure-storage-blob-sink.kamelet.yaml @@ -33,11 +33,7 @@ spec: description: |- Upload data to Azure Storage Blob. - 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. + 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. required: - accountName - containerName @@ -56,7 +52,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Blob access Key. + description: The Azure Storage Blob access key. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-blob-source.kamelet.yaml b/kamelets/azure-storage-blob-source.kamelet.yaml index 9c4717e23..8fcf7789d 100644 --- a/kamelets/azure-storage-blob-source.kamelet.yaml +++ b/kamelets/azure-storage-blob-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Storage Blob Source" description: |- - Consume Files from Azure Storage Blob. + Consume files from Azure Storage Blob. required: - period - accountName @@ -41,7 +41,7 @@ spec: properties: period: title: Period between Polls - description: The interval between fetches to the Azure Storage Container in milliseconds + description: The interval (in milliseconds) between fetches to the Azure Storage Container. type: integer default: 10000 accountName: @@ -56,7 +56,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Blob access Key. + description: The Azure Storage Blob access key. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-queue-sink.kamelet.yaml b/kamelets/azure-storage-queue-sink.kamelet.yaml index 4dcb5b9ed..c309fd79d 100644 --- a/kamelets/azure-storage-queue-sink.kamelet.yaml +++ b/kamelets/azure-storage-queue-sink.kamelet.yaml @@ -31,15 +31,12 @@ spec: definition: title: "Azure Storage Queue Sink" description: |- - Send Messages to Azure Storage queues. + Send events to Azure Storage queues. - The Kamelet is able to understand the following headers to be set: + 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. - - `expiration` / `ce-expiration`: as the time to live of the message in the queue. - - If the header won't be set the default of 7 days will be used. - - The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S — parses as 20.345 seconds, P2D — parses as 2 days. + A header is optional. If the header is not set, the default of `P27D` (7 days) is used. required: - accountName - queueName @@ -58,7 +55,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Queue access Key. + description: The Azure Storage Queue access key. type: string format: password x-descriptors: diff --git a/kamelets/azure-storage-queue-source.kamelet.yaml b/kamelets/azure-storage-queue-source.kamelet.yaml index 2b3bbb72f..40a4bf6ca 100644 --- a/kamelets/azure-storage-queue-source.kamelet.yaml +++ b/kamelets/azure-storage-queue-source.kamelet.yaml @@ -31,7 +31,7 @@ spec: definition: title: "Azure Storage Queue Source" description: |- - Receive Messages from Azure Storage queues. + Receive events from Azure Storage queues. required: - accountName - queueName @@ -50,7 +50,7 @@ spec: type: string accessKey: title: Access Key - description: The Azure Storage Queue access Key. + description: The Azure Storage Queue access key. type: string format: password x-descriptors: @@ -58,7 +58,7 @@ spec: - urn:camel:group:credentials maxMessages: title: Maximum Messages - description: Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. By default it will consider 1 message to be retrieved, the allowed range is 1 to 32 messages. + description: The maximum number of messages to get. You can specify a value between 1 and 32. The default is 1 (one message). If there are fewer than the maximum number of messages in the queue, then all the messages are returned. type: integer default: 1 dependencies: From 3efe77d5f866d862961f1519313781bbaadb8a60 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 10:19:40 -0400 Subject: [PATCH 02/17] doc-config-descriptions-edit google --- kamelets/google-bigquery-sink.kamelet.yaml | 12 +++++------ kamelets/google-calendar-source.kamelet.yaml | 22 ++++++++++---------- kamelets/google-functions-sink.kamelet.yaml | 12 +++++------ kamelets/google-pubsub-sink.kamelet.yaml | 10 ++++----- kamelets/google-pubsub-source.kamelet.yaml | 16 +++++++------- kamelets/google-storage-sink.kamelet.yaml | 20 +++++++++--------- kamelets/google-storage-source.kamelet.yaml | 12 +++++------ 7 files changed, 49 insertions(+), 55 deletions(-) diff --git a/kamelets/google-bigquery-sink.kamelet.yaml b/kamelets/google-bigquery-sink.kamelet.yaml index ead10e48c..30b3593b7 100644 --- a/kamelets/google-bigquery-sink.kamelet.yaml +++ b/kamelets/google-bigquery-sink.kamelet.yaml @@ -32,9 +32,7 @@ spec: description: |- Send data to a Google Big Query table. - It is expected the body is in Json format representing an object or an array of objects. - - The credentialsFileLocation property needs to be a path to a service account key file. + The data must be JSON format to represent an object or an array of objects. required: - projectId - dataset @@ -44,19 +42,19 @@ spec: properties: projectId: title: Google Cloud Project Id - description: Google Cloud Project id + description: The Google Cloud Project ID. type: string dataset: title: Big Query Dataset Id - description: The Big Query Dataset Id + description: The Big Query Dataset ID. type: string table: title: Big Query Table Id - description: The Big Query Table Id + description: The Big Query Table ID. type: string credentialsFileLocation: title: Google Cloud Platform Credential File - description: The credential to access Google Cloud Platform api services + description: The credential for accessing Google Cloud Platform API services. This value must be a path to a service account key file. type: string x-descriptors: - urn:camel:group:credentials diff --git a/kamelets/google-calendar-source.kamelet.yaml b/kamelets/google-calendar-source.kamelet.yaml index 958113268..5630cd3f2 100644 --- a/kamelets/google-calendar-source.kamelet.yaml +++ b/kamelets/google-calendar-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "Google Calendar Source" description: |- - Receive data from Google Calendar. + Receive event data from Google Calendar. required: - index - calendarId @@ -43,15 +43,15 @@ spec: properties: index: title: Index - description: An index for the google calendar endpoint + description: An index for the Google Calendar endpoint. type: string calendarId: title: Calendar ID - description: The calendar ID to be used as events source + description: The calendar ID to use as the source of event data. type: string clientId: title: Client Id - description: Client ID of the calendar application + description: The Client ID of the Google Calendar application. type: string format: password x-descriptors: @@ -59,7 +59,7 @@ spec: - urn:camel:group:credentials clientSecret: title: Client Secret - description: Client Secret of the calendar application + description: The Client secret of the Google Calendar application. type: string format: password x-descriptors: @@ -67,7 +67,7 @@ spec: - urn:camel:group:credentials accessToken: title: Access Token - description: OAuth 2 access token for google calendar application. This typically expires after an hour so refreshToken is recommended for long term usage. + description: The OAuth 2 access token for the Google Calendar application. This token typically expires after an hour. For long term usage, set the `refreshToken` property. type: string format: password x-descriptors: @@ -75,7 +75,7 @@ spec: - urn:camel:group:credentials refreshToken: title: Refresh Token - description: OAuth 2 refresh token for google calendar application. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. + description: The OAuth 2 refresh token for the Google Calendar application. The Google Calendar component can obtain a new `accessToken` whenever the current one expires. Set this value for long term usage. type: string format: password x-descriptors: @@ -83,23 +83,23 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll. type: integer default: 500 applicationName: title: Application name - description: Google Calendar application name + description: The Google Calendar application name. type: string syncFlow: title: Sync Flow - description: Sync events for incremental synchronization + description: Specifies to sync events for incremental synchronization. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false consumeFromNow: title: Consume from now - description: Consume events in the selected calendar from now on + description: Specfies to consume events in the calendar from now on. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/google-functions-sink.kamelet.yaml b/kamelets/google-functions-sink.kamelet.yaml index 0056e2fa3..61ee44e3c 100644 --- a/kamelets/google-functions-sink.kamelet.yaml +++ b/kamelets/google-functions-sink.kamelet.yaml @@ -30,9 +30,7 @@ spec: definition: title: "Google Functions Sink" description: |- - Send messages to Google Functions. - - The serviceAccountKey property needs to be a path to a service account key file. + Send data to Google Functions. required: - projectId - functionName @@ -42,19 +40,19 @@ spec: properties: projectId: title: Project Id - description: The Google Cloud Functions Project Id + description: The Google Cloud Functions Project ID. type: string region: title: Region - description: The Region where the Google Cloud Functions has been deployed + description: The region where Google Cloud Functions has been deployed. type: string functionName: title: Function Name - description: The Function Name + description: The Function name. type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the Google Cloud Functions platform + description: The path to the service account key file that provides credentials for the Google Cloud Functions platform. type: string x-descriptors: - urn:camel:group:credentials diff --git a/kamelets/google-pubsub-sink.kamelet.yaml b/kamelets/google-pubsub-sink.kamelet.yaml index 0e06527dc..51371e68a 100644 --- a/kamelets/google-pubsub-sink.kamelet.yaml +++ b/kamelets/google-pubsub-sink.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Google Pubsub Sink" description: |- - Send messages to Google Pubsub. + Send messages to Google Cloud Pub/Sub. - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. + You must encode the `serviceAccountKey` property before you pass it as a parameter. required: - projectId - destinationName @@ -41,15 +41,15 @@ spec: properties: projectId: title: Project Id - description: The Google Cloud PubSub Project Id + description: The Google Cloud Pub/Sub Project ID. type: string destinationName: title: Destination Name - description: The Destination Name + description: The destination name. type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the PubSub publisher/subscriber + description: The service account key to use as credentials for the Pub/Sub publisher/subscriber. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials diff --git a/kamelets/google-pubsub-source.kamelet.yaml b/kamelets/google-pubsub-source.kamelet.yaml index 53e04abef..6f2a6a077 100644 --- a/kamelets/google-pubsub-source.kamelet.yaml +++ b/kamelets/google-pubsub-source.kamelet.yaml @@ -30,9 +30,7 @@ spec: definition: title: "Google Pubsub Source" description: |- - Consume messages from Google Pubsub. - - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. + Consume messages from Google Cloud Pub/Sub. required: - projectId - subscriptionName @@ -41,33 +39,33 @@ spec: properties: projectId: title: Project Id - description: The Google Cloud PubSub Project Id + description: The Google Cloud Pub/Sub Project ID. type: string subscriptionName: title: Subscription Name - description: The Subscription Name + description: The subscription name. type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the PubSub publisher/subscriber + description: The service account key to use as credentials for the Pub/Sub publisher/subscriber. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials synchronousPull: title: Synchronous Pull - description: If Synchronously pull batches of messages is enabled or not + description: Specifies to synchronously pull batches of messages. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false maxMessagesPerPoll: title: Max Messages Per Poll - description: The max number of messages to receive from the server in a single API call + description: The maximum number of messages to receive from the server in a single API call. type: integer default: 1 concurrentConsumers: title: Concurrent Consumers - description: The number of parallel streams consuming from the subscription + description: The number of parallel streams to consume from the subscription. type: integer default: 1 dependencies: diff --git a/kamelets/google-storage-sink.kamelet.yaml b/kamelets/google-storage-sink.kamelet.yaml index d448838d8..d4ab01694 100644 --- a/kamelets/google-storage-sink.kamelet.yaml +++ b/kamelets/google-storage-sink.kamelet.yaml @@ -30,13 +30,13 @@ spec: definition: title: "Google Storage Sink" description: |- - Upload Objects to Google Storage. - - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. - - - `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. + 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. required: - bucketNameOrArn - serviceAccountKey @@ -44,17 +44,17 @@ spec: properties: bucketNameOrArn: title: Bucket Name Or ARN - description: The Bucket Name or Bucket ARN + description: The Google Cloud Storage bucket name or Bucket Amazon Resource Name (ARN). type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the Google Cloud Storage access. + description: The service account key to use as credentials for Google Cloud Storage access. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the Google Cloud Storage bucket bucketNameOrArn. + description: Specifies to automatically create the Google Cloud Storage bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/google-storage-source.kamelet.yaml b/kamelets/google-storage-source.kamelet.yaml index b9455ca04..fb42a7613 100644 --- a/kamelets/google-storage-source.kamelet.yaml +++ b/kamelets/google-storage-source.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Google Storage Source" description: |- - Consume Objects from Google Storage. + Consume objects from Google Cloud Storage. - The serviceAccountKey property needs to be encoded in base64, so when you pass it as parameter, don't forget to encode it. + You must encode the `serviceAccountKey` property before you pass it as a parameter. required: - bucketNameOrArn - serviceAccountKey @@ -40,24 +40,24 @@ spec: properties: bucketNameOrArn: title: Bucket Name Or ARN - description: The Bucket Name or Bucket ARN + description: The Google Cloud Storage bucket name or Bucket Amazon Resource Name (ARN). type: string serviceAccountKey: title: Service Account Key - description: The Service account key that can be used as credentials for the Google Cloud Storage access. + description: TThe service account key to use as credentials for Google Cloud Storage access. You must encode this value in base64. type: binary x-descriptors: - urn:camel:group:credentials deleteAfterRead: title: Auto-delete Objects - description: Delete objects after consuming them + description: Specifies to delete objects after consuming them. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: true autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the Google Cloud Storage bucket bucketNameOrArn. + description: Specifies to automatically create the Google Cloud Storage bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' From dc67dbf25cbcbd5e83ed630129edd0f70677f416 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 10:21:26 -0400 Subject: [PATCH 03/17] doc-config-descriptions-edit messaging --- kamelets/http-sink.kamelet.yaml | 6 +++--- kamelets/jms-amqp-10-sink.kamelet.yaml | 8 ++++---- kamelets/jms-amqp-10-source.kamelet.yaml | 8 ++++---- kamelets/jms-apache-artemis-sink.kamelet.yaml | 8 ++++---- kamelets/jms-apache-artemis-source.kamelet.yaml | 8 ++++---- kamelets/rest-openapi-sink.kamelet.yaml | 6 +++--- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/kamelets/http-sink.kamelet.yaml b/kamelets/http-sink.kamelet.yaml index 6ebf541db..5101ebce3 100644 --- a/kamelets/http-sink.kamelet.yaml +++ b/kamelets/http-sink.kamelet.yaml @@ -29,20 +29,20 @@ metadata: spec: definition: title: HTTP Sink - description: Forwards an event to a HTTP endpoint + description: Forward data to a HTTP or HTTPS endpoint. required: - url type: object properties: url: title: URL - description: The URL to send data to + description: The URL to which you want to send data. type: string example: "https://my-service/path" pattern: "^(http|https)://.*" method: title: Method - description: The HTTP method to use + description: The HTTP method to use. type: string default: POST dependencies: diff --git a/kamelets/jms-amqp-10-sink.kamelet.yaml b/kamelets/jms-amqp-10-sink.kamelet.yaml index 6ef58e1e1..c40b71766 100644 --- a/kamelets/jms-amqp-10-sink.kamelet.yaml +++ b/kamelets/jms-amqp-10-sink.kamelet.yaml @@ -30,7 +30,7 @@ metadata: spec: definition: title: "JMS - AMQP 1.0 Kamelet Sink" - description: "A Kamelet that can produce events to any AMQP 1.0 compliant message broker using the Apache Qpid JMS client" + description: "Send data to any AMQP 1.0 compliant message broker by using the Apache Qpid JMS client." required: - destinationName - remoteURI @@ -38,16 +38,16 @@ spec: properties: destinationType: title: "Destination Type" - description: "The JMS destination type (i.e.: queue or topic)" + description: "The JMS destination type (queue or topic)." type: string default: queue destinationName: title: "Destination Name" - description: "The JMS destination name" + description: "The JMS destination name." type: string remoteURI: title: "Broker URL" - description: "The JMS URL" + description: "The JMS URL." type: string example: "amqp://my-host:31616" dependencies: diff --git a/kamelets/jms-amqp-10-source.kamelet.yaml b/kamelets/jms-amqp-10-source.kamelet.yaml index aa5d4a9c4..abaf9e233 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: "A Kamelet that can consume events from any AMQP 1.0 compliant message broker using the Apache Qpid JMS client" + description: "Consume data from any AMQP 1.0 compliant message broker by using the Apache." required: - destinationName - remoteURI @@ -38,16 +38,16 @@ spec: properties: destinationType: title: "Destination Type" - description: "The JMS destination type (i.e.: queue or topic)" + description: "The JMS destination type (queue or topic)." type: string default: queue destinationName: title: "Destination Name" - description: "The JMS destination name" + description: "The JMS destination name." type: string remoteURI: title: "Broker URL" - description: "The JMS URL" + description: "The JMS URL." type: string example: "amqp://my-host:31616" dependencies: diff --git a/kamelets/jms-apache-artemis-sink.kamelet.yaml b/kamelets/jms-apache-artemis-sink.kamelet.yaml index 6ea47c797..d6476f3f8 100644 --- a/kamelets/jms-apache-artemis-sink.kamelet.yaml +++ b/kamelets/jms-apache-artemis-sink.kamelet.yaml @@ -30,7 +30,7 @@ metadata: spec: definition: title: "JMS - Apache Artemis Kamelet Sink" - description: "A Kamelet that can produce events to an Apache Artemis message broker using JMS" + description: "Send data to an Apache Artemis message broker by using JMS." required: - destinationName - brokerURL @@ -38,17 +38,17 @@ spec: properties: destinationType: title: "Destination Type" - description: "The JMS destination type (i.e.: queue or topic)" + description: "The JMS destination type (queue or topic)." type: string default: queue destinationName: title: "Destination Name" - description: "The JMS destination name" + description: "The JMS destination name." type: string example: person brokerURL: title: "Broker URL" - description: "The JMS URL" + description: "The JMS URL." type: string example: "tcp://my-host:61616" dependencies: diff --git a/kamelets/jms-apache-artemis-source.kamelet.yaml b/kamelets/jms-apache-artemis-source.kamelet.yaml index 7473504c9..2a003a7a9 100644 --- a/kamelets/jms-apache-artemis-source.kamelet.yaml +++ b/kamelets/jms-apache-artemis-source.kamelet.yaml @@ -30,7 +30,7 @@ metadata: spec: definition: title: "JMS - Apache Artemis Kamelet Source" - description: "A Kamelet that can consume events from an Apache Artemis message broker using JMS" + description: "Receive data from an Apache Artemis message broker by using JMS." required: - destinationName - brokerURL @@ -38,16 +38,16 @@ spec: properties: destinationType: title: "Destination Type" - description: "The JMS destination type (i.e.: queue or topic)" + description: "The JMS destination type (queue or topic)." type: string default: queue destinationName: title: "Destination Name" - description: "The JMS destination name" + description: "The JMS destination name." type: string brokerURL: title: "Broker URL" - description: "The JMS URL" + description: "The JMS URL." type: string example: "tcp://k3s-node-master.usersys.redhat.com:31616" dependencies: diff --git a/kamelets/rest-openapi-sink.kamelet.yaml b/kamelets/rest-openapi-sink.kamelet.yaml index a2b8787ae..f78d98b2b 100644 --- a/kamelets/rest-openapi-sink.kamelet.yaml +++ b/kamelets/rest-openapi-sink.kamelet.yaml @@ -29,7 +29,7 @@ metadata: spec: definition: title: REST OpenAPI Sink - description: Load OpenAPI specification from URI and call an operation on the HTTP service. The request is generated respecting the rules given in the OpenAPI specification (e.g. path parameters, Content-Type). + description: Load an OpenAPI specification from a URI and call an operation on a HTTP service. The request that is generated respects the rules given in the OpenAPI specification (for example, path parameters and Content-Type). required: - specification - operation @@ -37,13 +37,13 @@ spec: properties: specification: title: Specification URI - description: URI to the OpenApi specification file + description: The URI to the OpenApi specification file. type: string example: "https://api.example.com/openapi.json" pattern: "^(http|https|file|classpath)://.*" operation: title: Operation ID - description: The operation to call + description: The operation to call. type: string dependencies: - "camel:rest-openapi" From 42766636dfca5b2d56551ffa2f40bc29c11627af Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 10:23:01 -0400 Subject: [PATCH 04/17] doc-config-descriptions-edit nosql --- kamelets/cassandra-sink.kamelet.yaml | 20 ++++++------ kamelets/cassandra-source.kamelet.yaml | 18 +++++------ .../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 19351b141..fbf4d36e0 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 a6d85105f..174664660 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 4e613c4e9..edf376b24 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 6f1438664..b174ce8ed 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 57191fcab..307d6fb5e 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" From d5268722035d942c0f1c8fb8e59afadaddd9034d Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 11:03:45 -0400 Subject: [PATCH 05/17] doc-config-descriptions-edit saas --- kamelets/jira-source.kamelet.yaml | 8 +++---- kamelets/salesforce-create-sink.kamelet.yaml | 19 +++++++-------- kamelets/salesforce-delete-sink.kamelet.yaml | 18 +++++++------- kamelets/salesforce-source.kamelet.yaml | 16 ++++++------- kamelets/salesforce-update-sink.kamelet.yaml | 25 ++++++++++---------- 5 files changed, 43 insertions(+), 43 deletions(-) diff --git a/kamelets/jira-source.kamelet.yaml b/kamelets/jira-source.kamelet.yaml index aa8755f92..a2cd0bd6a 100644 --- a/kamelets/jira-source.kamelet.yaml +++ b/kamelets/jira-source.kamelet.yaml @@ -39,18 +39,18 @@ spec: properties: jiraUrl: title: Jira URL - description: The URL of your instance of Jira + description: The URL of your instance of Jira. type: string example: http://my_jira.com:8081 username: title: Username - description: The username to access Jira + description: The username to access Jira. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password or the API Token to access Jira + description: The password or the API Token to access Jira. type: string format: password x-descriptors: @@ -58,7 +58,7 @@ spec: - urn:camel:group:credentials jql: title: JQL - description: A query to filter issues + description: A query to filter issues. type: string example: project=MyProject diff --git a/kamelets/salesforce-create-sink.kamelet.yaml b/kamelets/salesforce-create-sink.kamelet.yaml index 29083c8d8..1b018d78c 100644 --- a/kamelets/salesforce-create-sink.kamelet.yaml +++ b/kamelets/salesforce-create-sink.kamelet.yaml @@ -30,10 +30,9 @@ spec: definition: title: "Salesforce Create Sink" description: |- - Creates an object in Salesforce. The body of the message must contain - the JSON of the salesforce object. - - Example body: { "Phone": "555", "Name": "Antonia", "LastName": "Garcia" } + Creates 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" }` required: - clientId - clientSecret @@ -43,23 +42,23 @@ spec: properties: sObjectName: title: Object Name - description: Type of the object + description: The type of the object. type: string example: Contact loginUrl: title: Login URL - description: The Salesforce instance login URL + description: The Salesforce instance login URL. type: string default: https://login.salesforce.com clientId: title: Consumer Key - description: The Salesforce application consumer key + description: The Salesforce application consumer key. type: string x-descriptors: - urn:camel:group:credentials clientSecret: title: Consumer Secret - description: The Salesforce application consumer secret + description: The Salesforce application consumer secret. type: string format: password x-descriptors: @@ -67,13 +66,13 @@ spec: - urn:camel:group:credentials userName: title: Username - description: The Salesforce username + description: The Salesforce username. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The Salesforce user password + description: The Salesforce user password. type: string format: password x-descriptors: diff --git a/kamelets/salesforce-delete-sink.kamelet.yaml b/kamelets/salesforce-delete-sink.kamelet.yaml index 7f9b038a9..58b4cac82 100644 --- a/kamelets/salesforce-delete-sink.kamelet.yaml +++ b/kamelets/salesforce-delete-sink.kamelet.yaml @@ -30,10 +30,10 @@ spec: definition: title: "Salesforce Delete Sink" description: |- - Removes an object from Salesforce. The body received must be a json - containing two keys: sObjectId and sObjectName. - - Example body: { "sObjectId": "XXXXX0", "sObjectName": "Contact" } + Remove an object from Salesforce. + + The data body must be JSON-formatted and it must + contain two keys: `sObjectId` and `sObjectName`. For example: `{ "sObjectId": "XXXXX0", "sObjectName": "Contact" }` required: - clientId - clientSecret @@ -43,18 +43,18 @@ spec: properties: loginUrl: title: Login URL - description: The Salesforce instance login URL + description: The Salesforce instance login URL. type: string default: https://login.salesforce.com clientId: title: Consumer Key - description: The Salesforce application consumer key + description: The Salesforce application consumer key. type: string x-descriptors: - urn:camel:group:credentials clientSecret: title: Consumer Secret - description: The Salesforce application consumer secret + description: The Salesforce application consumer secret. type: string format: password x-descriptors: @@ -62,13 +62,13 @@ spec: - urn:camel:group:credentials userName: title: Username - description: The Salesforce username + description: The Salesforce username. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The Salesforce user password + description: The Salesforce user password. type: string format: password x-descriptors: diff --git a/kamelets/salesforce-source.kamelet.yaml b/kamelets/salesforce-source.kamelet.yaml index 5141574a0..edb8a1517 100644 --- a/kamelets/salesforce-source.kamelet.yaml +++ b/kamelets/salesforce-source.kamelet.yaml @@ -42,33 +42,33 @@ spec: properties: query: title: Query - description: The query to execute on Salesforce + description: The query to execute on Salesforce. type: string example: SELECT Id, Name, Email, Phone FROM Contact topicName: title: Topic Name - description: The name of the topic/channel to use + description: The name of the topic or channel. type: string example: ContactTopic loginUrl: title: Login URL - description: The Salesforce instance login URL + description: The Salesforce instance login URL. type: string default: https://login.salesforce.com notifyForFields: title: Notify For Fields - description: Notify for fields, options are ALL, REFERENCED, SELECT, WHERE. + description: Notify for fields. Possible options: ALL, REFERENCED, SELECT, or WHERE. type: string default: ALL clientId: title: Consumer Key - description: The Salesforce application consumer key + description: The Salesforce application consumer key. type: string x-descriptors: - urn:camel:group:credentials clientSecret: title: Consumer Secret - description: The Salesforce application consumer secret + description: The Salesforce application consumer secret. type: string format: password x-descriptors: @@ -76,13 +76,13 @@ spec: - urn:camel:group:credentials userName: title: Username - description: The Salesforce username + description: The Salesforce username. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The Salesforce user password + description: The Salesforce user password. type: string format: password x-descriptors: diff --git a/kamelets/salesforce-update-sink.kamelet.yaml b/kamelets/salesforce-update-sink.kamelet.yaml index c67172c19..164019af8 100644 --- a/kamelets/salesforce-update-sink.kamelet.yaml +++ b/kamelets/salesforce-update-sink.kamelet.yaml @@ -30,11 +30,12 @@ spec: definition: title: "Salesforce Update Sink" description: |- - Updates an object in Salesforce. The body received must contain a - JSON key-value pair for each property to update and sObjectName and - sObjectId must be provided as parameters. - - Example of key-value pair: { "Phone": "1234567890", "Name": "Antonia" } + 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 include the `sObjectName` and `sObjectId` properties. + required: - sObjectName - sObjectId @@ -46,27 +47,27 @@ spec: properties: sObjectName: title: Object Name - description: Type of the object. Only required if using key-value pair. + description: The type of the Salesforce object. Required if using a key-value pair. type: string example: Contact sObjectId: title: Object Id - description: Id of the object. Only required if using key-value pair. + description: The ID of the Salesforce object. Required if using a key-value pair. type: string loginUrl: title: Login URL - description: The Salesforce instance login URL + description: The Salesforce instance login URL. type: string default: https://login.salesforce.com clientId: title: Consumer Key - description: The Salesforce application consumer key + description: The Salesforce application consumer key. type: string x-descriptors: - urn:camel:group:credentials clientSecret: title: Consumer Secret - description: The Salesforce application consumer secret + description: The Salesforce application consumer secret. type: string format: password x-descriptors: @@ -74,13 +75,13 @@ spec: - urn:camel:group:credentials userName: title: Username - description: The Salesforce username + description: The Salesforce username. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The Salesforce user password + description: The Salesforce user password. type: string format: password x-descriptors: From 3a8c87b3a9bef52f0aa0db38a89957a113cffe7f Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 11:21:35 -0400 Subject: [PATCH 06/17] doc-config-descriptions-edit social --- kamelets/slack-sink.kamelet.yaml | 4 ++-- kamelets/slack-source.kamelet.yaml | 6 +++--- kamelets/telegram-sink.kamelet.yaml | 10 +++++----- kamelets/telegram-source.kamelet.yaml | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/kamelets/slack-sink.kamelet.yaml b/kamelets/slack-sink.kamelet.yaml index b3d44e3ce..f7273acb6 100644 --- a/kamelets/slack-sink.kamelet.yaml +++ b/kamelets/slack-sink.kamelet.yaml @@ -55,11 +55,11 @@ spec: type: string iconUrl: title: Icon URL - description: The avatar that the component will use when sending message to a channel or user. + description: The avatar to use when sending a message to a channel or user. type: string username: title: Username - description: This is the username that the bot will have when sending messages to a channel or user. + description: The username for the bot when it sends messages to a channel or user. type: string types: out: diff --git a/kamelets/slack-source.kamelet.yaml b/kamelets/slack-source.kamelet.yaml index 2985b26d6..7260f2d70 100644 --- a/kamelets/slack-source.kamelet.yaml +++ b/kamelets/slack-source.kamelet.yaml @@ -38,12 +38,12 @@ spec: properties: channel: title: Channel - description: The Slack channel to receive messages from + description: The Slack channel to receive messages from. type: string example: "#myroom" token: title: Token - description: The token to access Slack. A Slack app is needed. The token to access Slack. This app needs to have channels:history, groups:history, im:history, mpim:history, channels:read, groups:read, im:read and mpim:read permissions. The User OAuth Token is the kind of token needed. + description: The Bot User OAuth Access Token to access Slack. A Slack app that has the following permissions is required: `channels:history`, `groups:history`, `im:history`, `mpim:history`, `channels:read`, `groups:read`, `im:read`, and `mpim:read`. type: string format: password x-descriptors: @@ -51,7 +51,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: The delay between polls + description: The delay between polls. type: string example: "1s" types: diff --git a/kamelets/telegram-sink.kamelet.yaml b/kamelets/telegram-sink.kamelet.yaml index bcd39cee6..8df4568e7 100644 --- a/kamelets/telegram-sink.kamelet.yaml +++ b/kamelets/telegram-sink.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Telegram Sink" description: |- - Send a message to a Telegram chat using your Telegram bot as sender. + Send a message to a Telegram chat by using your Telegram bot as sender. - To create a bot, contact the @botfather account using the Telegram app. + To create a bot, use your Telegram app to contact the @botfather account. This sink supports the following message types: @@ -40,10 +40,10 @@ spec: - PNG images (`Content-Type` must be set to `image/png`) - JPEG images (`Content-Type` must be set to `image/jpeg`) - This following message headers are also supported: + This sink also supports the following message headers: - `text` / `ce-text`: when sending an image, the image caption - - `chat-id` / `ce-chatid`: to override the default chat where messages are sent to + - `chat-id` / `ce-chatid`: overrides the default chat where messages are sent to required: - authorizationToken type: object @@ -58,7 +58,7 @@ spec: - urn:camel:group:credentials chatId: title: Chat ID - description: The Chat ID where messages should be sent by default + description: The Chat ID to where you want to send messages by default. type: string types: out: diff --git a/kamelets/telegram-source.kamelet.yaml b/kamelets/telegram-source.kamelet.yaml index 816614449..9ad07e4fd 100644 --- a/kamelets/telegram-source.kamelet.yaml +++ b/kamelets/telegram-source.kamelet.yaml @@ -32,11 +32,11 @@ spec: description: |- Receive all messages that people send to your Telegram bot. - To create a bot, contact the @botfather account using the Telegram app. + To create a bot, contact the @botfather account by using the Telegram app. - The source attaches the following headers to the messages: + The source attaches the following header to the messages: - - `chat-id` / `ce-chatid`: the ID of the chat where the message comes from + - `chat-id` / `ce-chatid`: The ID of the chat where the message comes from. required: - authorizationToken From eb4e7457542a3f80ec9d5365fec2746e44289519 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 11:59:31 -0400 Subject: [PATCH 07/17] doc-config-descriptions-edit database --- kamelets/aws-redshift-sink.kamelet.yaml | 16 ++++++++-------- kamelets/aws-redshift-source.kamelet.yaml | 18 +++++++++--------- kamelets/jms-ibm-mq-sink.kamelet.yaml | 2 +- kamelets/jms-ibm-mq-source.kamelet.yaml | 2 +- kamelets/mariadb-sink.kamelet.yaml | 18 +++++++++--------- kamelets/mariadb-source.kamelet.yaml | 14 +++++++------- kamelets/mysql-sink.kamelet.yaml | 18 +++++++++--------- kamelets/mysql-source.kamelet.yaml | 16 ++++++++-------- kamelets/oracle-database-sink.kamelet.yaml | 18 +++++++++--------- kamelets/oracle-database-source.kamelet.yaml | 16 ++++++++-------- kamelets/postgresql-sink.kamelet.yaml | 16 ++++++++-------- kamelets/postgresql-source.kamelet.yaml | 14 +++++++------- kamelets/sqlserver-sink.kamelet.yaml | 18 +++++++++--------- kamelets/sqlserver-source.kamelet.yaml | 14 +++++++------- 14 files changed, 100 insertions(+), 100 deletions(-) diff --git a/kamelets/aws-redshift-sink.kamelet.yaml b/kamelets/aws-redshift-sink.kamelet.yaml index 52d03238a..2fe5e1c63 100644 --- a/kamelets/aws-redshift-sink.kamelet.yaml +++ b/kamelets/aws-redshift-sink.kamelet.yaml @@ -32,11 +32,11 @@ spec: description: |- Send data to an AWS Redshift Database. - This Kamelet expects a JSON as body. The mapping between the JSON fields and parameters is done by key, so if you have the following query: + This Kamelet expects a JSON-formatted body. Use key:value pairs to map the JSON fields and parameters. For example, here is a query: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' - The Kamelet needs to receive as input something like: + Here is example input for the example query: '{ "username":"oscerd", "city":"Rome"}' required: @@ -49,23 +49,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the AWS RedShi data source. type: string default: 5439 username: title: Username - description: The username to use for accessing a secured AWS Redshift Database + description: The username to access a secured AWS Redshift Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured AWS Redshift Database + description: The password to access a secured AWS Redshift Database. type: string format: password x-descriptors: @@ -73,12 +73,12 @@ spec: - urn:camel:group:credentials query: title: Query - description: The Query to execute against the AWS Redshift Database + description: The query to execute against the AWS Redshift Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the AWS RedShift Database. type: string types: in: diff --git a/kamelets/aws-redshift-source.kamelet.yaml b/kamelets/aws-redshift-source.kamelet.yaml index f3efdc6ee..488a947a0 100644 --- a/kamelets/aws-redshift-source.kamelet.yaml +++ b/kamelets/aws-redshift-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: definition: title: "AWS Redshift Source" description: |- - Query data from an AWS Redshift Database. + Query data from an AWS RedShift Database. required: - serverName - username @@ -41,23 +41,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 5439 username: title: Username - description: The username to use for accessing a secured AWS Redshift Database + description: The username to access a secured AWS RedShift Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured AWS Redshift Database + description: The password to access a secured AWS RedShift Database. type: string format: password x-descriptors: @@ -65,21 +65,21 @@ spec: - urn:camel:group:credentials query: title: Query - description: The Query to execute against the AWS Redshift Database + description: The query to execute against the AWS RedShift Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the AWS RedShift 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' delay: title: Delay - description: Milliseconds before the next poll from database + description: The number of milliseconds before the next poll from the AWS RedShift database. type: integer default: 500 types: diff --git a/kamelets/jms-ibm-mq-sink.kamelet.yaml b/kamelets/jms-ibm-mq-sink.kamelet.yaml index 10a718978..dcb199fe0 100644 --- a/kamelets/jms-ibm-mq-sink.kamelet.yaml +++ b/kamelets/jms-ibm-mq-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- A Kamelet that can produce events to an IBM MQ message queue using JMS. - In your KameletBinding file you'll need to explicitly declare the IBM MQ Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the IBM MQ Server driver dependency in spec->integration->dependencies - "mvn:com.ibm.mq:com.ibm.mq.allclient:" diff --git a/kamelets/jms-ibm-mq-source.kamelet.yaml b/kamelets/jms-ibm-mq-source.kamelet.yaml index 07ef03eec..6e310e2d3 100644 --- a/kamelets/jms-ibm-mq-source.kamelet.yaml +++ b/kamelets/jms-ibm-mq-source.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- A Kamelet that can read events from an IBM MQ message queue using JMS. - In your KameletBinding file you'll need to explicitly declare the IBM MQ Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the IBM MQ Server driver dependency in spec->integration->dependencies - "mvn:com.ibm.mq:com.ibm.mq.allclient:" diff --git a/kamelets/mariadb-sink.kamelet.yaml b/kamelets/mariadb-sink.kamelet.yaml index 068947ead..5933567c6 100644 --- a/kamelets/mariadb-sink.kamelet.yaml +++ b/kamelets/mariadb-sink.kamelet.yaml @@ -32,15 +32,15 @@ spec: description: |- Send data to a MariaDB Database. - In your KameletBinding file you'll need to explicitly declare the MariaDB Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the MariaDB Server driver dependency in spec->integration->dependencies. - "mvn:org.mariadb.jdbc:mariadb-java-client:" - This Kamelet expects a JSON as body. The mapping between the JSON fields and parameters is done by key, so if you have the following query: + This Kamelet expects a JSON-formatted body. Use key:value pairs to map the JSON fields and parameters. For example, here is a query: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' - The Kamelet needs to receive as input something like: + Here is example input for the example query: '{ "username":"oscerd", "city":"Rome"}' required: @@ -53,23 +53,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 3306 username: title: Username - description: The username to use for accessing 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 use for accessing a secured MariaDB Database + description: The password to access a secured MariaDB 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 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 Database Name we are pointing + description: The name of the MariaDB Database Name. type: string types: in: diff --git a/kamelets/mariadb-source.kamelet.yaml b/kamelets/mariadb-source.kamelet.yaml index 024b969c7..44ff33db2 100644 --- a/kamelets/mariadb-source.kamelet.yaml +++ b/kamelets/mariadb-source.kamelet.yaml @@ -32,7 +32,7 @@ spec: description: |- Query data from a MariaDB Database. - In your KameletBinding file you'll need to explicitly declare the MariaDB Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the MariaDB Server driver dependency in spec->integration->dependencies - "mvn:org.mariadb.jdbc:mariadb-java-client:" required: @@ -45,23 +45,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 3306 username: title: Username - description: The username to use for accessing 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 use for accessing a secured MariaDB Database + description: The password to access a secured MariaDB Database type: string format: password x-descriptors: @@ -69,12 +69,12 @@ 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 Database Name we are pointing + description: The name of the Database. type: string consumedQuery: title: Consumed Query diff --git a/kamelets/mysql-sink.kamelet.yaml b/kamelets/mysql-sink.kamelet.yaml index 50cb80404..10bf9d1de 100644 --- a/kamelets/mysql-sink.kamelet.yaml +++ b/kamelets/mysql-sink.kamelet.yaml @@ -32,15 +32,15 @@ spec: description: |- Send data to a MySQL Database. - In your KameletBinding file you'll need to explicitly declare the SQL Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the SQL Server driver dependency in spec->integration->dependencies. - "mvn:mysql:mysql-connector-java:" - This Kamelet expects a JSON as body. The mapping between the JSON fields and parameters is done by key, so if you have the following query: + This Kamelet expects a JSON-formatted body. Use key:value pairs to map the JSON fields and parameters. For example, here is a query: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' - The Kamelet needs to receive as input something like: + Here is example input for the example query: '{ "username":"oscerd", "city":"Rome"}' required: @@ -53,23 +53,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 3306 username: title: Username - description: The username to use for accessing a secured MySQL Database + description: The username to access a secured MySQL Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured MySQL Database + description: The password to access a secured MySQL 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 MySQL Database + description: The query to execute against the MySQL Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the MySQL Database. type: string types: in: diff --git a/kamelets/mysql-source.kamelet.yaml b/kamelets/mysql-source.kamelet.yaml index 107890404..ed15de409 100644 --- a/kamelets/mysql-source.kamelet.yaml +++ b/kamelets/mysql-source.kamelet.yaml @@ -32,7 +32,7 @@ spec: description: |- Query data from a MySQL Database. - In your KameletBinding file you'll need to explicitly declare the SQL Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the SQL Server driver dependency in spec->integration->dependencies. - "mvn:mysql:mysql-connector-java:" required: @@ -45,23 +45,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 3306 username: title: Username - description: The username to use for accessing a secured MySQL Database + description: The username to access a secured MySQL Database type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured MySQL Database + description: The password to access a secured MySQL 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 MySQL Database + description: The query to execute against the MySQL Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the MySQL 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/oracle-database-sink.kamelet.yaml b/kamelets/oracle-database-sink.kamelet.yaml index 252eead48..f8bb0e41d 100644 --- a/kamelets/oracle-database-sink.kamelet.yaml +++ b/kamelets/oracle-database-sink.kamelet.yaml @@ -32,15 +32,15 @@ spec: description: |- Send data to a Oracle Database. - In your KameletBinding file you'll need to explicitly declare the Oracle Database driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the Oracle Database driver dependency in spec->integration->dependencies. - "mvn:com.oracle.database.jdbc:ojdbc11:" - This Kamelet expects a JSON as body. The mapping between the JSON fields and parameters is done by key, so if you have the following query: + This Kamelet expects a JSON-formatted body. Use key:value pairs to map the JSON fields and parameters. For example, here is a query: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' - The Kamelet needs to receive as input something like: + Here is example input for the example query: '{ "username":"oscerd", "city":"Rome"}' required: @@ -53,23 +53,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 1521 username: title: Username - description: The username to use for accessing a secured Oracle Database + description: The username to access a secured Oracle Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured Oracle Database + description: The password to access a secured Oracle 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 Oracle Database + description: The query to execute against the Oracle Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the Oracle Database. type: string types: in: diff --git a/kamelets/oracle-database-source.kamelet.yaml b/kamelets/oracle-database-source.kamelet.yaml index 1bc965bb0..0ea6fcbee 100644 --- a/kamelets/oracle-database-source.kamelet.yaml +++ b/kamelets/oracle-database-source.kamelet.yaml @@ -32,7 +32,7 @@ spec: description: |- Query data from a Oracle Database. - In your KameletBinding file you'll need to explicitly declare the Oracle Database driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the Oracle Database driver dependency in spec->integration->dependencies. - "mvn:com.oracle.database.jdbc:ojdbc11:" required: @@ -45,23 +45,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 1521 username: title: Username - description: The username to use for accessing a secured Oracle Database + description: The username to access a secured Oracle Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured Oracle Database + description: The password to access a secured Oracle 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 Oracle Database + description: The query to execute against the Oracle Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the Oracle 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/postgresql-sink.kamelet.yaml b/kamelets/postgresql-sink.kamelet.yaml index 55c6f0ffc..f1a19054d 100644 --- a/kamelets/postgresql-sink.kamelet.yaml +++ b/kamelets/postgresql-sink.kamelet.yaml @@ -32,11 +32,11 @@ spec: description: |- Send data to a PostgreSQL Database. - This Kamelet expects a JSON as body. The mapping between the JSON fields and parameters is done by key, so if you have the following query: + This Kamelet expects a JSON-formatted body. Use key:value pairs to map the JSON fields and parameters. For example, here is a query: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' - The Kamelet needs to receive as input something like: + Here is example input for the example query: '{ "username":"oscerd", "city":"Rome"}' required: @@ -49,23 +49,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 5432 username: title: Username - description: The username to use for accessing a secured PostgreSQL Database + description: The username to access a secured PostgreSQL Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured PostgreSQL Database + description: The password to access a secured PostgreSQL Database. type: string format: password x-descriptors: @@ -73,12 +73,12 @@ spec: - urn:camel:group:credentials query: title: Query - description: The Query to execute against the PostgreSQL Database + description: The query to execute against the PostgreSQL Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the PostgreSQL Database. type: string types: in: diff --git a/kamelets/postgresql-source.kamelet.yaml b/kamelets/postgresql-source.kamelet.yaml index cd1ad6db7..eb277084e 100644 --- a/kamelets/postgresql-source.kamelet.yaml +++ b/kamelets/postgresql-source.kamelet.yaml @@ -41,23 +41,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 5432 username: title: Username - description: The username to use for accessing a secured PostgreSQL Database + description: The username to access a secured PostgreSQL Database. type: string x-descriptors: - urn:camel:group:credentials password: title: Password - description: The password to use for accessing a secured PostgreSQL Database + description: The password to access a secured PostgreSQL Database. type: string format: password x-descriptors: @@ -65,16 +65,16 @@ spec: - urn:camel:group:credentials query: title: Query - description: The Query to execute against the PostgreSQL Database + description: The query to execute against the PostgreSQL Database. type: string example: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' databaseName: title: Database Name - description: The Database Name we are pointing + description: The name of the PostgreSQL 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/sqlserver-sink.kamelet.yaml b/kamelets/sqlserver-sink.kamelet.yaml index b18545690..0e3a2ea02 100644 --- a/kamelets/sqlserver-sink.kamelet.yaml +++ b/kamelets/sqlserver-sink.kamelet.yaml @@ -32,15 +32,15 @@ spec: description: |- Send data to a Microsoft SQL Server Database. - In your KameletBinding file you'll need to explicitly declare the SQL Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the SQL Server driver dependency in spec->integration->dependencies - "mvn:com.microsoft.sqlserver:mssql-jdbc:" - This Kamelet expects a JSON as body. The mapping between the JSON fields and parameters is done by key, so if you have the following query: + This Kamelet expects a JSON-formatted body. Use key:value pairs to map the JSON fields and parameters. For example, here is a query: 'INSERT INTO accounts (username,city) VALUES (:#username,:#city)' - The Kamelet needs to receive as input something like: + Here is example input for the example query: '{ "username":"oscerd", "city":"Rome"}' required: @@ -53,23 +53,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 1433 username: title: Username - description: The username to use for accessing 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 use for accessing 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 Database Name we are pointing + description: The name of the Database. type: string types: in: diff --git a/kamelets/sqlserver-source.kamelet.yaml b/kamelets/sqlserver-source.kamelet.yaml index b81fa26b9..b6902242f 100644 --- a/kamelets/sqlserver-source.kamelet.yaml +++ b/kamelets/sqlserver-source.kamelet.yaml @@ -32,7 +32,7 @@ spec: description: |- Query data from a Microsoft SQL Server Database. - In your KameletBinding file you'll need to explicitly declare the SQL Server driver dependency in spec->integration->dependencies + In your KameletBinding file, you must explicitly declare the SQL Server driver dependency in spec->integration->dependencies - "mvn:com.microsoft.sqlserver:mssql-jdbc:" required: @@ -45,23 +45,23 @@ spec: properties: serverName: title: Server Name - description: Server Name for the data source + description: The server name for the data source. type: string example: localhost serverPort: title: Server Port - description: Server Port for the data source + description: The server port for the data source. type: string default: 1433 username: title: Username - description: The username to use for accessing 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 use for accessing a secured SQL Server Database + description: The password to access a secured SQL Server Database type: string format: password x-descriptors: @@ -69,12 +69,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 Database Name we are pointing + description: The name of the Database. type: string consumedQuery: title: Consumed Query From 17e6cb52a97f32a01593ecf66e7b76058f701d0d Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 12:27:08 -0400 Subject: [PATCH 08/17] 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 1bbf46094..db9b51737 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 36bbcaa4c..b5227a782 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 998fcde4c..6bf2044b2 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 5f7f8d1c6..12c4d1d5d 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 16167dd17..16808505d 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 6874ed25b..f53829032 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 01c883e12..798bec4f7 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 a6525b780..af9f7f8e1 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 1a419d46c..bb3efc5f0 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: From a97527b144b5d06547f143a8383e6d8d3719cb96 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 17:51:18 -0400 Subject: [PATCH 09/17] doc-config-descriptions-edit aws and misc --- kamelets/aws-cloudwatch-sink.kamelet.yaml | 23 ++++++------ kamelets/aws-ddb-sink.kamelet.yaml | 30 +++++++--------- kamelets/aws-ddb-streams-source.kamelet.yaml | 24 ++++++------- kamelets/aws-ec2-sink.kamelet.yaml | 14 ++++---- .../aws-kinesis-firehose-sink.kamelet.yaml | 12 +++---- kamelets/aws-kinesis-sink.kamelet.yaml | 31 +++++++--------- kamelets/aws-kinesis-source.kamelet.yaml | 20 +++++------ kamelets/aws-lambda-sink.kamelet.yaml | 14 ++++---- kamelets/aws-s3-sink.kamelet.yaml | 24 ++++++------- kamelets/aws-s3-source.kamelet.yaml | 35 ++++++++++--------- .../aws-s3-streaming-upload-sink.kamelet.yaml | 10 +++--- .../aws-secrets-manager-sink.kamelet.yaml | 4 +-- kamelets/aws-ses-sink.kamelet.yaml | 24 ++++++------- kamelets/aws-sns-fifo-sink.kamelet.yaml | 12 +++---- kamelets/aws-sns-sink.kamelet.yaml | 24 ++++++------- kamelets/aws-sqs-batch-sink.kamelet.yaml | 12 +++---- kamelets/aws-sqs-fifo-sink.kamelet.yaml | 12 +++---- kamelets/aws-sqs-sink.kamelet.yaml | 24 ++++++------- kamelets/aws-sqs-source.kamelet.yaml | 16 ++++----- kamelets/aws-translate-action.kamelet.yaml | 4 +-- .../elasticsearch-search-source.kamelet.yaml | 2 +- kamelets/google-mail-source.kamelet.yaml | 2 +- kamelets/google-sheets-source.kamelet.yaml | 2 +- kamelets/salesforce-create-sink.kamelet.yaml | 2 +- kamelets/splunk-source.kamelet.yaml | 2 +- kamelets/ssh-source.kamelet.yaml | 2 +- kamelets/websocket-source.kamelet.yaml | 2 +- 27 files changed, 183 insertions(+), 200 deletions(-) diff --git a/kamelets/aws-cloudwatch-sink.kamelet.yaml b/kamelets/aws-cloudwatch-sink.kamelet.yaml index 96a5092df..2f2b7cc4c 100644 --- a/kamelets/aws-cloudwatch-sink.kamelet.yaml +++ b/kamelets/aws-cloudwatch-sink.kamelet.yaml @@ -31,16 +31,13 @@ spec: definition: title: "AWS CloudWatch Metrics Sink" description: |- - Send messages to AWS CloudWatch metrics. + Send data to Amazon CloudWatch metrics. - Access Key/Secret Key are the basic method for authenticating to the AWS CloudWatch Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the AWS CloudWatch metrics service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the CloudWatch client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. - - The Kamelet expects the following headers to be set: - - - There are several properties you can set in the headers, such as: + If you use the default credentials provider, the CloudWatch client loads the credentials through this provider and doesn't use the basic authentication method. + + You can set the following properties in the header: `metric-name` / `ce-metricname` for the metric name. `metric-value` / `ce-metricvalue` for the metric value. @@ -55,7 +52,7 @@ spec: properties: cwNamespace: title: Cloud Watch Namespace - description: The cloud watch metric namespace. + description: The CloudWatch metric namespace. type: string accessKey: title: Access Key @@ -75,24 +72,24 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the CloudWatch client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the CloudWatch client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index 32bb78b00..c8cec8e33 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -31,17 +31,13 @@ spec: definition: title: "AWS DynamoDB Sink" description: |- - Send data to AWS DynamoDB service. The sent data will insert/update/delete an item on the given AWS DynamoDB table. + Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes an item on the specified AWS DynamoDB table. - Access Key/Secret Key are the basic method for authenticating to the AWS DynamoDB service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the AWS CloudWatch metrics service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the AWS DynamoDB client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + If you use the default credentials provider, the CloudWatch client loads the credentials through this provider and doesn't use the basic authentication method. - This Kamelet expects a JSON as body. The mapping between the JSON fields and table attribute values is done by key, so if you have the input: - - '{"username":"oscerd", "city":"Rome"}' - - The Kamelet will insert/update an item in the given AWS DynamoDB table and set the attributes 'username' and 'city' respectively. Please note that the JSON object must include the primary key values that define the item. + This Kamelet expects a JSON-formatted body and it must include the primary key values that define the DynamoDB item. The mapping between the JSON fields and table attribute values is done by key. For example, for '{"username":"oscerd", "city":"Rome"}' input, the Kamelet inserts or update an item in the specified AWS DynamoDB table and sets the values for the 'username' and 'city' attributes. required: - table - region @@ -49,11 +45,11 @@ spec: properties: table: title: Table - description: Name of the DynamoDB table to look at + description: The name of the DynamoDB table. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -61,7 +57,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -69,35 +65,35 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] operation: title: Operation - description: The operation to perform (one of PutItem, UpdateItem, DeleteItem) + description: The operation to perform: `PutItem`, `UpdateItem`, or DeleteItem. type: string default: PutItem example: PutItem writeCapacity: title: Write Capacity - description: The provisioned throughput to reserved for writing resources to your table + description: The provisioned throughput to reserve for writing resources to your table type: integer default: 1 useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the DynamoDB client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the DynamoDB client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-ddb-streams-source.kamelet.yaml b/kamelets/aws-ddb-streams-source.kamelet.yaml index d33b50eda..e09f4e511 100644 --- a/kamelets/aws-ddb-streams-source.kamelet.yaml +++ b/kamelets/aws-ddb-streams-source.kamelet.yaml @@ -31,11 +31,11 @@ spec: definition: title: "AWS DynamoDB Streams Source" description: |- - Receive events from AWS DynamoDB Streams. + Receive events from Amazon DynamoDB Streams. - Access Key/Secret Key are the basic method for authenticating to the AWS DynamoDB Streams Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the AWS DynamoDB Streams service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the AWS DynamoDB Streams client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + If you use the default credentials provider, the DynamoDB Streams client loads the credentials through this provider and doesn't use the basic authentication method. required: - table - region @@ -43,11 +43,11 @@ spec: properties: table: title: Table - description: Name of the DynamoDB table to look at + description: The name of the DynamoDB table. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,36 +63,36 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] streamIteratorType: title: Stream Iterator Type - description: Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. There are 2 enums and the value can be one of FROM_LATEST and FROM_START + description: Defines where in the DynamoDB stream to start getting records. There are two enums and the value can be one of FROM_LATEST and FROM_START. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. type: string default: FROM_LATEST useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the AWS DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the DynamoDB client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll from database + description: The number of milliseconds before the next poll from the database. type: integer default: 500 types: diff --git a/kamelets/aws-ec2-sink.kamelet.yaml b/kamelets/aws-ec2-sink.kamelet.yaml index 3ae260534..23272623c 100644 --- a/kamelets/aws-ec2-sink.kamelet.yaml +++ b/kamelets/aws-ec2-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Check the status of EC2 instances - Access Key/Secret Key are the basic method for authenticating to the AWS EC2 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS EC2 Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the EC2 client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. @@ -46,7 +46,7 @@ spec: properties: accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -54,7 +54,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -62,24 +62,24 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the EC2 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the CloudWatch client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-kinesis-firehose-sink.kamelet.yaml b/kamelets/aws-kinesis-firehose-sink.kamelet.yaml index 2756edd70..a66eaa1ab 100644 --- a/kamelets/aws-kinesis-firehose-sink.kamelet.yaml +++ b/kamelets/aws-kinesis-firehose-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Send message to an AWS Kinesis Firehose Stream - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Firehose Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Firehose Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the Kinesis Firehose client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. required: @@ -47,7 +47,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,7 +63,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] @@ -76,11 +76,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-kinesis-sink.kamelet.yaml b/kamelets/aws-kinesis-sink.kamelet.yaml index c4a2c9bd4..cdb165b1d 100644 --- a/kamelets/aws-kinesis-sink.kamelet.yaml +++ b/kamelets/aws-kinesis-sink.kamelet.yaml @@ -33,21 +33,16 @@ spec: description: |- Send data to AWS Kinesis. - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the Kinesis client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. - - The Kamelet expects the following header: - - - `partition` / `ce-partition`: to set the Kinesis partition key - - If the header won't be set the exchange ID will be used. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. + + In the header, you can optionally set the `file` / `ce-partition` property to set the Kinesis partition key. - The Kamelet is also able to recognize the following header: + If you do not set the property in the header, the Kamelet uses the exchange ID for the partition key. - - `sequence-number` / `ce-sequencenumber`: to set the Sequence number + You can also set the `sequence-number` / `ce-sequencenumber` property in the header to specify the Sequence number. - This header is optional. required: - stream - region @@ -55,11 +50,11 @@ spec: properties: stream: title: Stream Name - description: The Kinesis stream that you want to access (needs to be created in advance) + description: The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -67,7 +62,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -75,24 +70,24 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-kinesis-source.kamelet.yaml b/kamelets/aws-kinesis-source.kamelet.yaml index e21e97db6..d0b1f0cd9 100644 --- a/kamelets/aws-kinesis-source.kamelet.yaml +++ b/kamelets/aws-kinesis-source.kamelet.yaml @@ -33,9 +33,9 @@ spec: description: |- Receive data from AWS Kinesis. - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the Kinesis client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - stream - region @@ -43,11 +43,11 @@ spec: properties: stream: title: Stream Name - description: The Kinesis stream that you want to access (needs to be created in advance) + description: The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,31 +63,31 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll of the selected stream + description: The number of milliseconds before the next poll of the selected stream. type: integer default: 500 types: diff --git a/kamelets/aws-lambda-sink.kamelet.yaml b/kamelets/aws-lambda-sink.kamelet.yaml index ac87254ca..6a422f47c 100644 --- a/kamelets/aws-lambda-sink.kamelet.yaml +++ b/kamelets/aws-lambda-sink.kamelet.yaml @@ -33,9 +33,9 @@ spec: description: |- Send a payload to an AWS Lambda function. - Access Key/Secret Key are the basic method for authenticating to the AWS Lambda Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the Lambda client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - function - region @@ -43,11 +43,11 @@ spec: properties: function: title: Function Name - description: The Lambda Function name + description: The Lambda Function name. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,13 +63,13 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the Lambda client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the Lambda client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-s3-sink.kamelet.yaml b/kamelets/aws-s3-sink.kamelet.yaml index 595cecc8f..c29b913cf 100644 --- a/kamelets/aws-s3-sink.kamelet.yaml +++ b/kamelets/aws-s3-sink.kamelet.yaml @@ -31,17 +31,15 @@ spec: definition: title: "AWS S3 Sink" description: |- - Upload data to AWS S3 Bucket. + Upload data to an Amazon S3 Bucket. - Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the S3 client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. - The Kamelet can use the following headers to be set to: + In the header, you can optionally set the `file` / `ce-partition` property to specify the name of the file to upload. - - `file` / `ce-file`: as the file name to be uploaded - - If neither of those headers are set and the Kamelet parameter `keyName` is not populated, then the default file name used will be the `exchange id`. + If you do not set the property in the header, the Kamelet uses the exchange ID for the file name. required: - bucketNameOrArn - region @@ -49,7 +47,7 @@ spec: properties: bucketNameOrArn: title: Bucket Name - description: The S3 Bucket name or ARN. + description: The S3 Bucket name or Amazon Resource Name (ARN). type: string accessKey: title: Access Key @@ -69,31 +67,31 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the S3 bucket bucketName. + description: Specifies to automatically create the S3 bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-s3-source.kamelet.yaml b/kamelets/aws-s3-source.kamelet.yaml index b1ced663f..41c47cbac 100644 --- a/kamelets/aws-s3-source.kamelet.yaml +++ b/kamelets/aws-s3-source.kamelet.yaml @@ -14,11 +14,11 @@ spec: definition: title: "AWS S3 Source" description: |- - Receive data from AWS S3 Bucket. + Receive data from an Amazon S3 Bucket. - Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. - - When using a default Credentials Provider the S3 client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. + + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - bucketNameOrArn - region @@ -26,18 +26,18 @@ spec: properties: bucketNameOrArn: title: Bucket Name - description: The S3 Bucket name or ARN + description: The S3 Bucket name or Amazon Resource Name (ARN). type: string deleteAfterRead: title: Auto-delete Objects - description: Delete objects after consuming them + description: Specifies to 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 AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -45,7 +45,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -53,57 +53,58 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the S3 bucket bucketName. + description: Specifies to automatically create the S3 bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false includeBody: title: Include Body - description: If it is true, the exchange will be consumed and put into the body and closed. If false the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. + 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' default: true prefix: title: Prefix - description: The AWS S3 bucket prefix to consider while searching + description: The AWS S3 bucket prefix to consider while searching. type: string example: 'folder/' ignoreBody: title: Ignore Body - description: If it is true, the S3 Object Body will be ignored completely, if it is set to false the S3 Object will be put in the body. Setting this to true, will override any behavior defined by includeBody option. + description: If true, the S3 Object body is ignored. Setting this to true overrides any behavior defined by the `includeBody` option. If false, the S3 object is put in the body. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll of the selected bucket + description: The number of milliseconds before the next poll of the selected bucket. type: integer default: 500 dependencies: diff --git a/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml b/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml index f07c6172f..e03068f88 100644 --- a/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml +++ b/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Upload data to AWS S3 in streaming upload mode. - Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the S3 client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. required: @@ -44,7 +44,7 @@ spec: properties: bucketNameOrArn: title: Bucket Name - description: The S3 Bucket name or ARN. + description: The S3 Bucket name or Amazon Resource Name (ARN).. type: string accessKey: title: Access Key @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] @@ -119,11 +119,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-secrets-manager-sink.kamelet.yaml b/kamelets/aws-secrets-manager-sink.kamelet.yaml index fe97378f5..2f468afe2 100644 --- a/kamelets/aws-secrets-manager-sink.kamelet.yaml +++ b/kamelets/aws-secrets-manager-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Create a secret in AWS Secrets Manager. - Access Key/Secret Key are the basic method for authenticating to the AWS Secrets Manager Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS Secrets Manager Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the Secrets Manager client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] diff --git a/kamelets/aws-ses-sink.kamelet.yaml b/kamelets/aws-ses-sink.kamelet.yaml index e4e891433..86e3c1866 100644 --- a/kamelets/aws-ses-sink.kamelet.yaml +++ b/kamelets/aws-ses-sink.kamelet.yaml @@ -31,21 +31,19 @@ spec: definition: title: "AWS SES Sink" description: |- - Send Email through AWS SES Service. + Send email through the Amazon Simple Email Service (SES). - Access Key/Secret Key are the basic method for authenticating to the AWS SES Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the SES client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. - - The Kamelet expects the following headers to be set: - - - `subject` / `ce-subject`: The email subject - - If the header won't be set the exchange ID will be used as email subject. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. + + In the header, you can optionally set the following properties: + + - `subject` / `ce-subject` property to specify the email subject. If you do not set this property in the header, the Kamelet uses the exchange ID for the email subject. - - `to` / `ce-to`: a comma separated list of email addresses + - `to` / `ce-to` to provide a comma-separated list of email addresses. - - `reply-to-addresses` / `ce-reply-to-addresses`: a comma separated list of reply-to email addresses + - `reply-to-addresses` / `ce-reply-to-addresses`to provider a comma-separated list of reply-to email addresses. required: - from @@ -75,13 +73,13 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SES client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SES client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sns-fifo-sink.kamelet.yaml b/kamelets/aws-sns-fifo-sink.kamelet.yaml index 17d4a8f4f..f4df0f319 100644 --- a/kamelets/aws-sns-fifo-sink.kamelet.yaml +++ b/kamelets/aws-sns-fifo-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Send message to an AWS SNS FIFO Topic. - Access Key/Secret Key are the basic method for authenticating to the AWS SNS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS SNS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the SNS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. @@ -51,7 +51,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. 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 AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -67,7 +67,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] @@ -94,11 +94,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sns-sink.kamelet.yaml b/kamelets/aws-sns-sink.kamelet.yaml index 84c1cb0dd..79c0072d5 100644 --- a/kamelets/aws-sns-sink.kamelet.yaml +++ b/kamelets/aws-sns-sink.kamelet.yaml @@ -31,15 +31,13 @@ spec: definition: title: AWS SNS Sink description: |- - Send message to an AWS SNS Topic. + Send message to an Amazon Simple Notification Service (SNS) topic. - Access Key/Secret Key are the basic method for authenticating to the AWS SNS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the SNS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. - The Kamelet expects the following headers to be set: - - - `subject` / `ce-subject`: the subject of the message + In the header, you can optionally set the `subject` / `ce-subject` property to specify the subject of the message. required: - topicNameOrArn - region @@ -47,11 +45,11 @@ spec: properties: topicNameOrArn: title: Topic Name - description: The SQS Topic name or ARN + description: The SNS topic name name or Amazon Resource Name (ARN). type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -59,7 +57,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -67,7 +65,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] @@ -80,18 +78,18 @@ spec: default: false useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SNS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SNS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-batch-sink.kamelet.yaml b/kamelets/aws-sqs-batch-sink.kamelet.yaml index 9b85a8299..3e9a39ee2 100644 --- a/kamelets/aws-sqs-batch-sink.kamelet.yaml +++ b/kamelets/aws-sqs-batch-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Send Batch message to an AWS SQS Queue. - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. required: @@ -48,7 +48,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -56,7 +56,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] @@ -100,11 +100,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-fifo-sink.kamelet.yaml b/kamelets/aws-sqs-fifo-sink.kamelet.yaml index b282c75dd..2bb864136 100644 --- a/kamelets/aws-sqs-fifo-sink.kamelet.yaml +++ b/kamelets/aws-sqs-fifo-sink.kamelet.yaml @@ -34,7 +34,7 @@ spec: Send message to an AWS SQS FIFO Queue. - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. required: @@ -48,7 +48,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -56,7 +56,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] @@ -102,11 +102,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-sink.kamelet.yaml b/kamelets/aws-sqs-sink.kamelet.yaml index 25b344a4c..7b1ab311e 100644 --- a/kamelets/aws-sqs-sink.kamelet.yaml +++ b/kamelets/aws-sqs-sink.kamelet.yaml @@ -31,11 +31,11 @@ spec: definition: title: AWS SQS Sink description: |- - Send message to an AWS SQS Queue. + Send messages to an Amazon Simple Queue Service (SQS) queue. - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - queueNameOrArn - region @@ -43,11 +43,11 @@ spec: properties: queueNameOrArn: title: Queue Name - description: The SQS Queue name or ARN + description: The SQS Queue name or or Amazon Resource Name (ARN). type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,13 +63,13 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] autoCreateQueue: title: Autocreate Queue - description: Setting the autocreation of the SQS queue. + description: Automatically create the SQS queue. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' @@ -81,24 +81,24 @@ spec: default: amazonaws.com protocol: title: Protocol - description: The underlying protocol used to communicate with SQS + description: The underlying protocol used to communicate with SQS. type: string example: http or https default: https useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SQS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-source.kamelet.yaml b/kamelets/aws-sqs-source.kamelet.yaml index 7d0d56e99..d8e1182ba 100644 --- a/kamelets/aws-sqs-source.kamelet.yaml +++ b/kamelets/aws-sqs-source.kamelet.yaml @@ -34,7 +34,7 @@ spec: description: |- Receive data from AWS SQS. - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. required: @@ -55,7 +55,7 @@ spec: default: true accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -65,7 +65,7 @@ spec: - urn:keda:required secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -75,7 +75,7 @@ spec: - urn:keda:required region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 x-descriptors: @@ -109,25 +109,25 @@ spec: - urn:keda:required useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SQS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll of the selected stream + description: The number of milliseconds before the next poll of the selected stream type: integer default: 500 dependencies: diff --git a/kamelets/aws-translate-action.kamelet.yaml b/kamelets/aws-translate-action.kamelet.yaml index fced614e0..18279ca0a 100644 --- a/kamelets/aws-translate-action.kamelet.yaml +++ b/kamelets/aws-translate-action.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Translate a text in a specific language. - Access Key/Secret Key are the basic method for authenticating to the AWS Translate Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS Translate Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the Translate client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. required: @@ -60,7 +60,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] diff --git a/kamelets/elasticsearch-search-source.kamelet.yaml b/kamelets/elasticsearch-search-source.kamelet.yaml index 9ace230b5..13c3d2616 100644 --- a/kamelets/elasticsearch-search-source.kamelet.yaml +++ b/kamelets/elasticsearch-search-source.kamelet.yaml @@ -78,7 +78,7 @@ spec: type: string clusterName: title: ElasticSearch Cluster Name - description: Name of the cluster. + description: The name of the cluster. type: string types: out: diff --git a/kamelets/google-mail-source.kamelet.yaml b/kamelets/google-mail-source.kamelet.yaml index 7acd02993..7b36c7f69 100644 --- a/kamelets/google-mail-source.kamelet.yaml +++ b/kamelets/google-mail-source.kamelet.yaml @@ -78,7 +78,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll type: integer default: 500 applicationName: diff --git a/kamelets/google-sheets-source.kamelet.yaml b/kamelets/google-sheets-source.kamelet.yaml index 675d0395b..186643a34 100644 --- a/kamelets/google-sheets-source.kamelet.yaml +++ b/kamelets/google-sheets-source.kamelet.yaml @@ -77,7 +77,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll type: integer default: 500 repeatCount: diff --git a/kamelets/salesforce-create-sink.kamelet.yaml b/kamelets/salesforce-create-sink.kamelet.yaml index 1b018d78c..2abff7641 100644 --- a/kamelets/salesforce-create-sink.kamelet.yaml +++ b/kamelets/salesforce-create-sink.kamelet.yaml @@ -32,7 +32,7 @@ spec: description: |- Creates 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/splunk-source.kamelet.yaml b/kamelets/splunk-source.kamelet.yaml index 3440990b0..40fc705aa 100644 --- a/kamelets/splunk-source.kamelet.yaml +++ b/kamelets/splunk-source.kamelet.yaml @@ -99,7 +99,7 @@ spec: type: integer delay: title: Delay - description: Milliseconds before the next poll. + description: The number of milliseconds before the next poll. type: integer query: title: Query diff --git a/kamelets/ssh-source.kamelet.yaml b/kamelets/ssh-source.kamelet.yaml index 3398bc4e8..be16f6666 100644 --- a/kamelets/ssh-source.kamelet.yaml +++ b/kamelets/ssh-source.kamelet.yaml @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll type: integer default: 500 pollCommand: diff --git a/kamelets/websocket-source.kamelet.yaml b/kamelets/websocket-source.kamelet.yaml index 38e7a4551..c551cdabd 100644 --- a/kamelets/websocket-source.kamelet.yaml +++ b/kamelets/websocket-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: default: 9292 resourceUri: title: Resource Uri - description: Name of the websocket channel to use. + description: The name of the websocket channel to use. type: string maxBinaryMessageSize: title: Max Binary Message Size From 7e6be8bcda8ee643a1b7cf53ffb152bcfff00c7a Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Mon, 11 Jul 2022 19:05:44 -0400 Subject: [PATCH 10/17] 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 +- .../azure-storage-queue-sink.kamelet.yaml | 5 +--- kamelets/cassandra-sink.kamelet.yaml | 4 ++-- kamelets/cassandra-source.kamelet.yaml | 8 +++---- .../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 c8cec8e33..997be2e1c 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 41c47cbac..60e1d06e2 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 3ba7422aa..4873fa284 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 85df8d211..aad130bec 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 c309fd79d..004d8259d 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 fbf4d36e0..19bbb5a47 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 174664660..b2662ad4f 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 edf376b24..2fb0f1378 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 db9b51737..1f1c4a980 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 b5227a782..1e4d1499f 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 12c4d1d5d..f121ee946 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 d4ab01694..8964be6fa 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 abaf9e233..98adc7941 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 5933567c6..18e8c5bdd 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 44ff33db2..7a3881291 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 f53829032..a96d4231e 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 b174ce8ed..7bce443f5 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 ed15de409..38ae947a1 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 f8bb0e41d..f4130adfa 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 0ea6fcbee..2b24c50ba 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 2abff7641..d41e9120d 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 164019af8..83db0abb4 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 af9f7f8e1..950552989 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 0e3a2ea02..317060513 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: From 4c637d9736edee12f66272cb7a53daefbbb1094e Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Tue, 12 Jul 2022 07:53:52 -0400 Subject: [PATCH 11/17] doc-config-descriptions-edit validation fix1 --- kamelets/aws-ddb-sink.kamelet.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index 997be2e1c..c86514763 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -71,7 +71,7 @@ spec: enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] operation: title: Operation - description: The operation to perform: `PutItem`, `UpdateItem`, or DeleteItem. + description: The operation to perform: PutItem, UpdateItem, or DeleteItem. type: string default: PutItem example: PutItem From 7e729da875289bb0bbba3e0fc596b7f84a187bac Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Tue, 12 Jul 2022 08:01:22 -0400 Subject: [PATCH 12/17] doc-config-descriptions-edit validation fix2 --- kamelets/aws-ddb-sink.kamelet.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index c86514763..853e7981f 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -71,7 +71,7 @@ spec: enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] operation: title: Operation - description: The operation to perform: PutItem, UpdateItem, or DeleteItem. + description: The operation to perform. The options are `PutItem`, `UpdateItem`, or `DeleteItem`. type: string default: PutItem example: PutItem From 27a3e32e8289903a7f382d7585f096a8558ebd1f Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Tue, 12 Jul 2022 08:12:37 -0400 Subject: [PATCH 13/17] doc-config-descriptions-edit validation fix3 --- kamelets/aws-ddb-sink.kamelet.yaml | 2 +- kamelets/cassandra-sink.kamelet.yaml | 2 +- kamelets/cassandra-source.kamelet.yaml | 4 ++-- kamelets/ftp-sink.kamelet.yaml | 2 +- kamelets/mongodb-sink.kamelet.yaml | 2 +- kamelets/pulsar-source.kamelet.yaml | 6 +++--- kamelets/salesforce-source.kamelet.yaml | 2 +- kamelets/sftp-sink.kamelet.yaml | 2 +- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index 853e7981f..945271f7a 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -71,7 +71,7 @@ spec: enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] operation: title: Operation - description: The operation to perform. The options are `PutItem`, `UpdateItem`, or `DeleteItem`. + description: The operation to perform. The options are PutItem, UpdateItem, or DeleteItem. type: string default: PutItem example: PutItem diff --git a/kamelets/cassandra-sink.kamelet.yaml b/kamelets/cassandra-sink.kamelet.yaml index 19bbb5a47..09f46ed85 100644 --- a/kamelets/cassandra-sink.kamelet.yaml +++ b/kamelets/cassandra-sink.kamelet.yaml @@ -71,7 +71,7 @@ spec: - urn:camel:group:credentials 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. 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: diff --git a/kamelets/cassandra-source.kamelet.yaml b/kamelets/cassandra-source.kamelet.yaml index b2662ad4f..fd6292bfd 100644 --- a/kamelets/cassandra-source.kamelet.yaml +++ b/kamelets/cassandra-source.kamelet.yaml @@ -69,12 +69,12 @@ spec: - urn:camel:group:credentials resultStrategy: title: Result Strategy - description: The strategy to convert the result set of the query. Possible values: ALL, ONE, LIMIT_10, or LIMIT_100. + description: The strategy to convert the result set of the query. Possible values are ALL, ONE, LIMIT_10, or LIMIT_100. type: string default: ALL consistencyLevel: title: Consistency Level - description: The consistency level to use. Possible values: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, or LOCAL_ONE. + description: The consistency level to use. Possible values are 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/ftp-sink.kamelet.yaml b/kamelets/ftp-sink.kamelet.yaml index 1f1c4a980..ea86556b1 100644 --- a/kamelets/ftp-sink.kamelet.yaml +++ b/kamelets/ftp-sink.kamelet.yaml @@ -79,7 +79,7 @@ spec: - '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. Possible values: Override, Append, Fail, or Ignore. + description: How to behave in case of file already existent. There are 4 enums. Possible values are Override, Append, Fail, or Ignore. type: string default: Override dependencies: diff --git a/kamelets/mongodb-sink.kamelet.yaml b/kamelets/mongodb-sink.kamelet.yaml index 7bce443f5..ead5130c4 100644 --- a/kamelets/mongodb-sink.kamelet.yaml +++ b/kamelets/mongodb-sink.kamelet.yaml @@ -69,7 +69,7 @@ spec: type: string writeConcern: title: Write Concern - description: The level of acknowledgment requested from MongoDB for write operations. Possible values: ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, or 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 diff --git a/kamelets/pulsar-source.kamelet.yaml b/kamelets/pulsar-source.kamelet.yaml index 178a26a87..fa14a076e 100644 --- a/kamelets/pulsar-source.kamelet.yaml +++ b/kamelets/pulsar-source.kamelet.yaml @@ -118,7 +118,7 @@ spec: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' subscriptionInitialPosition: title: Subscription Initial Position - description: "Control the initial position in the topic of a newly created subscription. Default is latest message.Possible values: EARLIEST or LATEST" + description: "Control the initial position in the topic of a newly created subscription. Default is latest message. Possible values are EARLIEST or LATEST." type: string default: LATEST subscriptionName: @@ -128,12 +128,12 @@ spec: default: subs subscriptionTopicsMode: title: Subscription Topics Mode - description: "Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions.Possible values: PersistentOnly, NonPersistentOnly, AllTopics" + description: "Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions.Possible values are PersistentOnly, NonPersistentOnly, or AllTopics." type: string default: PersistentOnly subscriptionType: title: Subscription Type - description: "Type of the subscription. Possible values: EXCLUSIVE, SHARED, FAILOVER, KEY_SHARED" + description: "Type of the subscription. Possible values are EXCLUSIVE, SHARED, FAILOVER, KEY_SHARED." type: string default: EXCLUSIVE topicsPattern: diff --git a/kamelets/salesforce-source.kamelet.yaml b/kamelets/salesforce-source.kamelet.yaml index edb8a1517..28b6c3f4d 100644 --- a/kamelets/salesforce-source.kamelet.yaml +++ b/kamelets/salesforce-source.kamelet.yaml @@ -57,7 +57,7 @@ spec: default: https://login.salesforce.com notifyForFields: title: Notify For Fields - description: Notify for fields. Possible options: ALL, REFERENCED, SELECT, or WHERE. + description: Notify for fields. Possible values are ALL, REFERENCED, SELECT, or WHERE. type: string default: ALL clientId: diff --git a/kamelets/sftp-sink.kamelet.yaml b/kamelets/sftp-sink.kamelet.yaml index 950552989..0ef40d57c 100644 --- a/kamelets/sftp-sink.kamelet.yaml +++ b/kamelets/sftp-sink.kamelet.yaml @@ -79,7 +79,7 @@ spec: - '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. Possible values: Override, Append, Fail, or Ignore + description: How to behave in case of file already existent. There are 4 enums. Possible values are Override, Append, Fail, or Ignore. type: string default: Override dependencies: From c32231c640a2c62e5fe0b5f4442fa49f3dedbef8 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Tue, 12 Jul 2022 08:19:40 -0400 Subject: [PATCH 14/17] doc-config-descriptions-edit validation fix4 --- kamelets/aws-ddb-sink.kamelet.yaml | 2 +- kamelets/ftps-sink.kamelet.yaml | 2 +- kamelets/pulsar-sink.kamelet.yaml | 4 ++-- kamelets/pulsar-source.kamelet.yaml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index 945271f7a..fb3435c1a 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -71,7 +71,7 @@ spec: enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] operation: title: Operation - description: The operation to perform. The options are PutItem, UpdateItem, or DeleteItem. + description: "The operation to perform. The options are PutItem, UpdateItem, or DeleteItem."" type: string default: PutItem example: PutItem diff --git a/kamelets/ftps-sink.kamelet.yaml b/kamelets/ftps-sink.kamelet.yaml index 6bf2044b2..7050519f5 100644 --- a/kamelets/ftps-sink.kamelet.yaml +++ b/kamelets/ftps-sink.kamelet.yaml @@ -79,7 +79,7 @@ spec: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' fileExist: title: File Existence - description: Specifies how the Kamelet behaves if the file already exists. The value can be: Override, Append, Fail, or Ignore. + description: "Specifies how the Kamelet behaves if the file already exists. Possible values are Override, Append, Fail, or Ignore." type: string default: Override dependencies: diff --git a/kamelets/pulsar-sink.kamelet.yaml b/kamelets/pulsar-sink.kamelet.yaml index a8857c44d..cbd9e19d9 100644 --- a/kamelets/pulsar-sink.kamelet.yaml +++ b/kamelets/pulsar-sink.kamelet.yaml @@ -51,7 +51,7 @@ spec: type: string topicType: title: Topic Type - description: "The topic type. Possible values are: persistent or non-persistent" + description: "The topic type. Possible values are persistent or non-persistent." type: string namespaceName: title: Pulsar Namespace Name @@ -97,7 +97,7 @@ spec: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' compressionType: title: Compression Type - description: "Compression type to use. Possible values are: NONE, LZ4, ZLIB, ZSTD, SNAPPY" + description: "Compression type to use. Possible values are NONE, LZ4, ZLIB, ZSTD, or SNAPPY." type: string default: "NONE" x-descriptors: diff --git a/kamelets/pulsar-source.kamelet.yaml b/kamelets/pulsar-source.kamelet.yaml index fa14a076e..ea863bbbe 100644 --- a/kamelets/pulsar-source.kamelet.yaml +++ b/kamelets/pulsar-source.kamelet.yaml @@ -51,7 +51,7 @@ spec: type: string topicType: title: Topic Type - description: "The topic type. Possible values are: persistent or non-persistent" + description: "The topic type. Possible values are persistent or non-persistent." type: string namespaceName: title: Pulsar Namespace Name From df197985a42ccf79d7f34a23fc606d795d956415 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Tue, 12 Jul 2022 08:27:49 -0400 Subject: [PATCH 15/17] doc-config-descriptions-edit validation fix5 --- kamelets/aws-ddb-sink.kamelet.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index fb3435c1a..5129d70af 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -71,7 +71,7 @@ spec: enum: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "fips-us-east-1", "fips-us-east-2", "fips-us-west-1", "fips-us-west-2", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1", "us-gov-east-1", "us-gov-west-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1"] operation: title: Operation - description: "The operation to perform. The options are PutItem, UpdateItem, or DeleteItem."" + description: "The operation to perform. The options are PutItem, UpdateItem, or DeleteItem." type: string default: PutItem example: PutItem From 86a7aa673af2a4ea6152e7693b7faacca1f49eb0 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Tue, 12 Jul 2022 08:39:09 -0400 Subject: [PATCH 16/17] doc-config-descriptions-edit validation fix6 --- kamelets/jms-amqp-10-source.kamelet.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kamelets/jms-amqp-10-source.kamelet.yaml b/kamelets/jms-amqp-10-source.kamelet.yaml index 98adc7941..4fd7e46d3 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 Qpid JMS client. + description: "Consume data from any AMQP 1.0 compliant message broker by using the Apache Qpid JMS client." required: - destinationName - remoteURI From ca661448baea74eadd22ec189c951d0d8adca6e6 Mon Sep 17 00:00:00 2001 From: MelissaFlinn Date: Tue, 12 Jul 2022 08:44:23 -0400 Subject: [PATCH 17/17] doc-config-descriptions-edit validation fix7 --- kamelets/slack-source.kamelet.yaml | 2 +- kamelets/telegram-sink.kamelet.yaml | 2 +- kamelets/telegram-source.kamelet.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/kamelets/slack-source.kamelet.yaml b/kamelets/slack-source.kamelet.yaml index 7260f2d70..a025b9e65 100644 --- a/kamelets/slack-source.kamelet.yaml +++ b/kamelets/slack-source.kamelet.yaml @@ -43,7 +43,7 @@ spec: example: "#myroom" token: title: Token - description: The Bot User OAuth Access Token to access Slack. A Slack app that has the following permissions is required: `channels:history`, `groups:history`, `im:history`, `mpim:history`, `channels:read`, `groups:read`, `im:read`, and `mpim:read`. + description: "The Bot User OAuth Access Token to access Slack. A Slack app that has the following permissions is required: `channels:history`, `groups:history`, `im:history`, `mpim:history`, `channels:read`, `groups:read`, `im:read`, and `mpim:read`." type: string format: password x-descriptors: diff --git a/kamelets/telegram-sink.kamelet.yaml b/kamelets/telegram-sink.kamelet.yaml index 8df4568e7..4d4776088 100644 --- a/kamelets/telegram-sink.kamelet.yaml +++ b/kamelets/telegram-sink.kamelet.yaml @@ -50,7 +50,7 @@ spec: properties: authorizationToken: title: Token - description: The token to access your bot on Telegram. You you can obtain it from the Telegram @botfather. + description: "The token to access your bot on Telegram. You you can obtain it from the Telegram @botfather." type: string format: password x-descriptors: diff --git a/kamelets/telegram-source.kamelet.yaml b/kamelets/telegram-source.kamelet.yaml index 9ad07e4fd..ff748d185 100644 --- a/kamelets/telegram-source.kamelet.yaml +++ b/kamelets/telegram-source.kamelet.yaml @@ -44,7 +44,7 @@ spec: properties: authorizationToken: title: Token - description: The token to access your bot on Telegram. You you can obtain it from the Telegram @botfather. + description: "The token to access your bot on Telegram. You you can obtain it from the Telegram @botfather." type: string format: password x-descriptors: