This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit 2d1af0cfe729d3ff799e275812990f3ac8e31553 Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 11:03:45 2022 -0400 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 aa8755f9..a2cd0bd6 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 29083c8d..1b018d78 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 7f9b038a..58b4cac8 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 5141574a..edb8a151 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 c67172c1..164019af 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:
