From 46a672c978abe2f52d982b206303ab5cdc36b98f Mon Sep 17 00:00:00 2001 From: Pratik Agrawal Date: Fri, 6 Sep 2024 13:36:54 +0530 Subject: [PATCH 1/3] [docs]: Update data-source/{airtable, amazon s3, amazon ses} --- docs/docs/data-sources/airtable.md | 37 +++++++----------- docs/docs/data-sources/amazonses.md | 12 ++---- docs/docs/data-sources/s3.md | 5 +-- .../data-sources/airtable.md | 39 +++++++------------ .../data-sources/amazonses.md | 13 ++----- .../version-2.50.0-LTS/data-sources/s3.md | 5 +-- .../version-2.65.0/data-sources/airtable.md | 39 +++++++------------ .../version-2.65.0/data-sources/amazonses.md | 12 ++---- .../version-2.65.0/data-sources/s3.md | 5 +-- 9 files changed, 56 insertions(+), 111 deletions(-) diff --git a/docs/docs/data-sources/airtable.md b/docs/docs/data-sources/airtable.md index ae72e590d9..b9faa148c7 100644 --- a/docs/docs/data-sources/airtable.md +++ b/docs/docs/data-sources/airtable.md @@ -39,19 +39,17 @@ This operation returns a list of records from the specified table. #### Required parameters: - **Base ID:** To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name:** The name of the table from which you want to fetch the records. +
#### Optional parameters: - **Page size:** The number of records returned in each request. Default is 100 records. - - **Offset:** The offset value is used to fetch the next set of records. The offset value is returned in the response of the previous request. - - **Filter by formula:** This parameter will only return records that satisfy the formula. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error!, the record will be included in the result. e.g. `Name = 'John'` - - **Fields:** The fields you want to retrieve. If you don't specify the fields, all fields will be returned. e.g. `["Name", "Email", "Survey Response"]` +
Airtable List Records Query
@@ -64,24 +62,24 @@ Example response from Airtable: { "id": "recu9xMnUdr2n2cw8", "fields": { - "Notes": "sdfdsf", - "Name": "dsfdsf" + "Notes": "Meeting to discuss project details", + "Name": "John Doe" }, "createdTime": "2021-05-12T14:30:33.000Z" }, { "id": "recyIdR7bVdQvmKXa", "fields": { - "Notes": "sdfdsf", - "Name": "dfds" + "Notes": "Follow-up call regarding contract", + "Name": "Jane Smith" }, "createdTime": "2021-05-12T14:30:33.000Z" }, { "id": "recAOzdIHaRpvRaGE", "fields": { - "Notes": "sdfsdfsd", - "Name": "sdfdsf" + "Notes": "Client feedback review meeting", + "Name": "Alice Johnson" }, "createdTime": "2021-05-12T14:30:33.000Z" } @@ -99,9 +97,7 @@ Example response from Airtable: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table from which you want to fetch the records. - - **Record ID**: The ID of the record you want to retrieve.
@@ -115,8 +111,8 @@ Example response from Airtable: { "id": "recu9xMnUdr2n2cw8", "fields": { - "Notes": "sdfdsf", - "Name": "dsfdsf" + "Notes": "Discuss project timeline", + "Name": "Michael Scott" }, "createdTime": "2021-05-12T14:30:33.000Z" } @@ -131,11 +127,9 @@ Example response from Airtable: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to create the record. - - **Records**: The records you want to create. The records should be in the form of an array of objects. Each object should have a `fields` key, which contains the fields of the record. The field names should be the same as the field names in the Airtable table. - +
Airtable Create Record Query
@@ -178,13 +172,10 @@ Query returns the following response when the record is created successfully: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to update the record. - - **Record ID**: The ID of the record you want to update. - - **Body**: The fields you want to update. The fields should be in the form of an object. The field names should be the same as the field names in the Airtable table. - +
Airtable Update Record Query
@@ -224,11 +215,9 @@ Query returns the following response when the record is updated successfully: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to delete the record. - - **Record ID**: The ID of the record you want to delete. - +
Airtable Delete Record Query
diff --git a/docs/docs/data-sources/amazonses.md b/docs/docs/data-sources/amazonses.md index c76da755df..a75d5b70fa 100644 --- a/docs/docs/data-sources/amazonses.md +++ b/docs/docs/data-sources/amazonses.md @@ -3,12 +3,8 @@ id: amazonses title: Amazon SES --- -
- ToolJet can connect to your Amazon SES account to send emails. -
-
## Connection @@ -39,10 +35,10 @@ Click on the **Save** button to save the data source. ### Email service Required parameters: -- Send email to -- Send email from -- Subject -- Body as text +- **Send email to** +- **Send email from** +- **Subject** +- **Body as text** Optional parameters: diff --git a/docs/docs/data-sources/s3.md b/docs/docs/data-sources/s3.md index 68eebd76f5..06c1541543 100644 --- a/docs/docs/data-sources/s3.md +++ b/docs/docs/data-sources/s3.md @@ -2,17 +2,14 @@ id: s3 title: Amazon S3 --- -
ToolJet can connect to **Amazon S3** buckets and perform various operation on them. -
-
## Connection -To establish a connection with the Amazon S3 data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard. +To establish a connection with the **Amazon S3** data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard. ToolJet supports connecting to AWS S3 using **IAM Access Keys**, **AWS Instance Credentials** or **AWS ARN Role**. diff --git a/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md b/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md index ae72e590d9..dadae4beb1 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md +++ b/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md @@ -39,19 +39,17 @@ This operation returns a list of records from the specified table. #### Required parameters: - **Base ID:** To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name:** The name of the table from which you want to fetch the records. +
#### Optional parameters: - **Page size:** The number of records returned in each request. Default is 100 records. - - **Offset:** The offset value is used to fetch the next set of records. The offset value is returned in the response of the previous request. - - **Filter by formula:** This parameter will only return records that satisfy the formula. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error!, the record will be included in the result. e.g. `Name = 'John'` - - **Fields:** The fields you want to retrieve. If you don't specify the fields, all fields will be returned. e.g. `["Name", "Email", "Survey Response"]` +
Airtable List Records Query
@@ -64,24 +62,24 @@ Example response from Airtable: { "id": "recu9xMnUdr2n2cw8", "fields": { - "Notes": "sdfdsf", - "Name": "dsfdsf" + "Notes": "Meeting to discuss project details", + "Name": "John Doe" }, "createdTime": "2021-05-12T14:30:33.000Z" }, { "id": "recyIdR7bVdQvmKXa", "fields": { - "Notes": "sdfdsf", - "Name": "dfds" + "Notes": "Follow-up call regarding contract", + "Name": "Jane Smith" }, "createdTime": "2021-05-12T14:30:33.000Z" }, { "id": "recAOzdIHaRpvRaGE", "fields": { - "Notes": "sdfsdfsd", - "Name": "sdfdsf" + "Notes": "Client feedback review meeting", + "Name": "Alice Johnson" }, "createdTime": "2021-05-12T14:30:33.000Z" } @@ -99,11 +97,9 @@ Example response from Airtable: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table from which you want to fetch the records. - - **Record ID**: The ID of the record you want to retrieve. - +
Airtable Retrieve Record Query
@@ -115,8 +111,8 @@ Example response from Airtable: { "id": "recu9xMnUdr2n2cw8", "fields": { - "Notes": "sdfdsf", - "Name": "dsfdsf" + "Notes": "Discuss project timeline", + "Name": "Michael Scott" }, "createdTime": "2021-05-12T14:30:33.000Z" } @@ -131,11 +127,9 @@ Example response from Airtable: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to create the record. - - **Records**: The records you want to create. The records should be in the form of an array of objects. Each object should have a `fields` key, which contains the fields of the record. The field names should be the same as the field names in the Airtable table. - +
Airtable Create Record Query
@@ -178,13 +172,10 @@ Query returns the following response when the record is created successfully: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to update the record. - - **Record ID**: The ID of the record you want to update. - - **Body**: The fields you want to update. The fields should be in the form of an object. The field names should be the same as the field names in the Airtable table. - +
Airtable Update Record Query
@@ -224,11 +215,9 @@ Query returns the following response when the record is updated successfully: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to delete the record. - - **Record ID**: The ID of the record you want to delete. - +
Airtable Delete Record Query
diff --git a/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md b/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md index c76da755df..184cbee329 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md +++ b/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md @@ -3,12 +3,8 @@ id: amazonses title: Amazon SES --- -
- ToolJet can connect to your Amazon SES account to send emails. -
-
## Connection @@ -35,14 +31,13 @@ Click on the **Save** button to save the data source.
## Supported operations -1. Email service ### Email service Required parameters: -- Send email to -- Send email from -- Subject -- Body as text +- **Send email to** +- **Send email from** +- **Subject** +- **Body as text** Optional parameters: diff --git a/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md b/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md index 68eebd76f5..06c1541543 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md +++ b/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md @@ -2,17 +2,14 @@ id: s3 title: Amazon S3 --- -
ToolJet can connect to **Amazon S3** buckets and perform various operation on them. -
-
## Connection -To establish a connection with the Amazon S3 data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard. +To establish a connection with the **Amazon S3** data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard. ToolJet supports connecting to AWS S3 using **IAM Access Keys**, **AWS Instance Credentials** or **AWS ARN Role**. diff --git a/docs/versioned_docs/version-2.65.0/data-sources/airtable.md b/docs/versioned_docs/version-2.65.0/data-sources/airtable.md index ae72e590d9..dadae4beb1 100644 --- a/docs/versioned_docs/version-2.65.0/data-sources/airtable.md +++ b/docs/versioned_docs/version-2.65.0/data-sources/airtable.md @@ -39,19 +39,17 @@ This operation returns a list of records from the specified table. #### Required parameters: - **Base ID:** To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name:** The name of the table from which you want to fetch the records. +
#### Optional parameters: - **Page size:** The number of records returned in each request. Default is 100 records. - - **Offset:** The offset value is used to fetch the next set of records. The offset value is returned in the response of the previous request. - - **Filter by formula:** This parameter will only return records that satisfy the formula. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error!, the record will be included in the result. e.g. `Name = 'John'` - - **Fields:** The fields you want to retrieve. If you don't specify the fields, all fields will be returned. e.g. `["Name", "Email", "Survey Response"]` +
Airtable List Records Query
@@ -64,24 +62,24 @@ Example response from Airtable: { "id": "recu9xMnUdr2n2cw8", "fields": { - "Notes": "sdfdsf", - "Name": "dsfdsf" + "Notes": "Meeting to discuss project details", + "Name": "John Doe" }, "createdTime": "2021-05-12T14:30:33.000Z" }, { "id": "recyIdR7bVdQvmKXa", "fields": { - "Notes": "sdfdsf", - "Name": "dfds" + "Notes": "Follow-up call regarding contract", + "Name": "Jane Smith" }, "createdTime": "2021-05-12T14:30:33.000Z" }, { "id": "recAOzdIHaRpvRaGE", "fields": { - "Notes": "sdfsdfsd", - "Name": "sdfdsf" + "Notes": "Client feedback review meeting", + "Name": "Alice Johnson" }, "createdTime": "2021-05-12T14:30:33.000Z" } @@ -99,11 +97,9 @@ Example response from Airtable: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table from which you want to fetch the records. - - **Record ID**: The ID of the record you want to retrieve. - +
Airtable Retrieve Record Query
@@ -115,8 +111,8 @@ Example response from Airtable: { "id": "recu9xMnUdr2n2cw8", "fields": { - "Notes": "sdfdsf", - "Name": "dsfdsf" + "Notes": "Discuss project timeline", + "Name": "Michael Scott" }, "createdTime": "2021-05-12T14:30:33.000Z" } @@ -131,11 +127,9 @@ Example response from Airtable: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to create the record. - - **Records**: The records you want to create. The records should be in the form of an array of objects. Each object should have a `fields` key, which contains the fields of the record. The field names should be the same as the field names in the Airtable table. - +
Airtable Create Record Query
@@ -178,13 +172,10 @@ Query returns the following response when the record is created successfully: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to update the record. - - **Record ID**: The ID of the record you want to update. - - **Body**: The fields you want to update. The fields should be in the form of an object. The field names should be the same as the field names in the Airtable table. - +
Airtable Update Record Query
@@ -224,11 +215,9 @@ Query returns the following response when the record is updated successfully: #### Required parameters: - **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - - **Table name**: The name of the table where you want to delete the record. - - **Record ID**: The ID of the record you want to delete. - +
Airtable Delete Record Query
diff --git a/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md b/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md index c76da755df..a75d5b70fa 100644 --- a/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md +++ b/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md @@ -3,12 +3,8 @@ id: amazonses title: Amazon SES --- -
- ToolJet can connect to your Amazon SES account to send emails. -
-
## Connection @@ -39,10 +35,10 @@ Click on the **Save** button to save the data source. ### Email service Required parameters: -- Send email to -- Send email from -- Subject -- Body as text +- **Send email to** +- **Send email from** +- **Subject** +- **Body as text** Optional parameters: diff --git a/docs/versioned_docs/version-2.65.0/data-sources/s3.md b/docs/versioned_docs/version-2.65.0/data-sources/s3.md index 68eebd76f5..06c1541543 100644 --- a/docs/versioned_docs/version-2.65.0/data-sources/s3.md +++ b/docs/versioned_docs/version-2.65.0/data-sources/s3.md @@ -2,17 +2,14 @@ id: s3 title: Amazon S3 --- -
ToolJet can connect to **Amazon S3** buckets and perform various operation on them. -
-
## Connection -To establish a connection with the Amazon S3 data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard. +To establish a connection with the **Amazon S3** data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard. ToolJet supports connecting to AWS S3 using **IAM Access Keys**, **AWS Instance Credentials** or **AWS ARN Role**. From 948feff3c1bf5b2f18bf8188aa2c4bcad47048bf Mon Sep 17 00:00:00 2001 From: Pratik Agrawal Date: Fri, 6 Sep 2024 17:14:36 +0530 Subject: [PATCH 2/3] [docs]: Update data-source/{airtable, amazon s3, amazon ses} --- docs/docs/data-sources/airtable.md | 25 ++------- docs/docs/data-sources/amazonses.md | 5 +- docs/docs/data-sources/s3.md | 53 ++++--------------- .../data-sources/airtable.md | 25 ++------- .../data-sources/amazonses.md | 4 +- .../version-2.50.0-LTS/data-sources/s3.md | 53 ++++--------------- .../version-2.65.0/data-sources/airtable.md | 25 ++------- .../version-2.65.0/data-sources/amazonses.md | 5 +- .../version-2.65.0/data-sources/s3.md | 53 ++++--------------- 9 files changed, 45 insertions(+), 203 deletions(-) diff --git a/docs/docs/data-sources/airtable.md b/docs/docs/data-sources/airtable.md index b9faa148c7..5631f6e35e 100644 --- a/docs/docs/data-sources/airtable.md +++ b/docs/docs/data-sources/airtable.md @@ -2,7 +2,6 @@ id: airtable title: Airtable --- -
ToolJet can connect to your **Airtable** account to read and write data. **Personal Access Token** is required to connect to the Airtable data source on ToolJet. You can generate the Personal Access Token by visiting **[Developer Hub from your Airtable profile](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens#understanding-personal-access-token-basic-actions)**. @@ -16,9 +15,7 @@ ToolJet can connect to your **Airtable** account to read and write data. **Perso Airtable API has a rate limit, and at the time of writing this documentation, the limit is five(5) requests per second per base. You can read more about rate limits here **[Airtable API](https://airtable.com/api)**. ::: -
- -
+
## Supported Operations @@ -30,7 +27,7 @@ Airtable API has a rate limit, and at the time of writing this documentation, th
-
+
### List records @@ -41,7 +38,6 @@ This operation returns a list of records from the specified table. - **Base ID:** To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - **Table name:** The name of the table from which you want to fetch the records. -
#### Optional parameters: - **Page size:** The number of records returned in each request. Default is 100 records. @@ -90,8 +86,6 @@ Example response from Airtable:
-
- ### Retrieve record #### Required parameters: @@ -118,10 +112,6 @@ Example response from Airtable: } ``` -
- -
- ### Create record #### Required parameters: @@ -163,10 +153,6 @@ Query returns the following response when the record is created successfully: } ``` -
- -
- ### Update record #### Required parameters: @@ -206,10 +192,6 @@ Query returns the following response when the record is updated successfully: } ``` -
- -
- ### Delete record #### Required parameters: @@ -229,5 +211,4 @@ Query returns the following response when the record is deleted successfully: deleted: true id: "recIKsyZgqI4zoqS7" } -``` -
\ No newline at end of file +``` \ No newline at end of file diff --git a/docs/docs/data-sources/amazonses.md b/docs/docs/data-sources/amazonses.md index a75d5b70fa..13a9cc0d34 100644 --- a/docs/docs/data-sources/amazonses.md +++ b/docs/docs/data-sources/amazonses.md @@ -5,7 +5,7 @@ title: Amazon SES ToolJet can connect to your Amazon SES account to send emails. -
+
## Connection To add a new **Amazon SES** API data source, click the **Data sources** icon on the left-sidebar of the app builder and click on the **+Add** button, then select Amazon SES from the modal that pops up. @@ -28,10 +28,9 @@ Click on the **Save** button to save the data source.
-
+
## Supported operations -1. Email service ### Email service Required parameters: diff --git a/docs/docs/data-sources/s3.md b/docs/docs/data-sources/s3.md index 06c1541543..8bc4ebce4a 100644 --- a/docs/docs/data-sources/s3.md +++ b/docs/docs/data-sources/s3.md @@ -5,7 +5,7 @@ title: Amazon S3 ToolJet can connect to **Amazon S3** buckets and perform various operation on them. -
+
## Connection @@ -49,7 +49,7 @@ You can now connect to **[different S3 Hosts using custom endpoints](/docs/how-t
-
+
## Querying AWS S3 @@ -69,7 +69,7 @@ Query results can be transformed using transformations. Read our [transformation
-
+
## Query operations @@ -85,8 +85,6 @@ You can create query for AWS S3 data source to perform several actions such as:
-
- ### Create a new bucket You can create a new bucket in your S3 by using this operation. @@ -101,10 +99,6 @@ You can create a new bucket in your S3 by using this operation.
-
- -
- ### Read object You can read an object in a bucket by using this operation. @@ -116,13 +110,9 @@ You can read an object in a bucket by using this operation.
- aws s3 read object + aws s3 read object
-
- -
- ### Upload object You can use this operation to upload objects(files) to your S3 bucket. @@ -136,13 +126,9 @@ You can use this operation to upload objects(files) to your S3 bucket.
- aws s3 upload + aws s3 upload
-
- -
- ### Remove object You can use this operation to remove an object from your S3 bucket. @@ -154,27 +140,19 @@ You can use this operation to remove an object from your S3 bucket.
- Create a new bucket - S3 operation + Create a new bucket - S3 operation
-
- -
- ### List buckets This operation will list all the buckets in your S3. This does not require any parameter.
- aws s3 bucket + aws s3 bucket
-
- -
- ### List objects in a bucket This operation will fetch the list of all the files in your bucket. It requires the following parameters: @@ -202,14 +180,10 @@ The results will continue from where the last listing finished.
-aws s3 list object +aws s3 list object
-
- -
- ### Signed url for download The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects. @@ -223,15 +197,10 @@ The object owner can optionally share objects with others by creating a presigne
-aws s3 signed download +aws s3 signed download
-
- -
- - ### Signed url for upload The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions. @@ -254,6 +223,4 @@ The presigned URLs are useful if you want your user/customer to be able to uploa :::info We built an app to view and upload files to AWS S3 buckets. Check out the complete tutorial **[here](https://blog.tooljet.com/build-an-aws-s3-broswer-with-tooljet/)**. -::: - -
\ No newline at end of file +::: \ No newline at end of file diff --git a/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md b/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md index dadae4beb1..c6e581b58e 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md +++ b/docs/versioned_docs/version-2.50.0-LTS/data-sources/airtable.md @@ -2,7 +2,6 @@ id: airtable title: Airtable --- -
ToolJet can connect to your **Airtable** account to read and write data. **Personal Access Token** is required to connect to the Airtable data source on ToolJet. You can generate the Personal Access Token by visiting **[Developer Hub from your Airtable profile](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens#understanding-personal-access-token-basic-actions)**. @@ -16,9 +15,7 @@ ToolJet can connect to your **Airtable** account to read and write data. **Perso Airtable API has a rate limit, and at the time of writing this documentation, the limit is five(5) requests per second per base. You can read more about rate limits here **[Airtable API](https://airtable.com/api)**. ::: -
- -
+
## Supported Operations @@ -30,7 +27,7 @@ Airtable API has a rate limit, and at the time of writing this documentation, th
-
+
### List records @@ -41,7 +38,6 @@ This operation returns a list of records from the specified table. - **Base ID:** To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - **Table name:** The name of the table from which you want to fetch the records. -
#### Optional parameters: - **Page size:** The number of records returned in each request. Default is 100 records. @@ -90,8 +86,6 @@ Example response from Airtable:
-
- ### Retrieve record #### Required parameters: @@ -118,10 +112,6 @@ Example response from Airtable: } ``` -
- -
- ### Create record #### Required parameters: @@ -163,10 +153,6 @@ Query returns the following response when the record is created successfully: } ``` -
- -
- ### Update record #### Required parameters: @@ -206,10 +192,6 @@ Query returns the following response when the record is updated successfully: } ``` -
- -
- ### Delete record #### Required parameters: @@ -229,5 +211,4 @@ Query returns the following response when the record is deleted successfully: deleted: true id: "recIKsyZgqI4zoqS7" } -``` -
\ No newline at end of file +``` \ No newline at end of file diff --git a/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md b/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md index 184cbee329..13a9cc0d34 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md +++ b/docs/versioned_docs/version-2.50.0-LTS/data-sources/amazonses.md @@ -5,7 +5,7 @@ title: Amazon SES ToolJet can connect to your Amazon SES account to send emails. -
+
## Connection To add a new **Amazon SES** API data source, click the **Data sources** icon on the left-sidebar of the app builder and click on the **+Add** button, then select Amazon SES from the modal that pops up. @@ -28,7 +28,7 @@ Click on the **Save** button to save the data source.
-
+
## Supported operations diff --git a/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md b/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md index 06c1541543..d27f3205ed 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md +++ b/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md @@ -5,7 +5,7 @@ title: Amazon S3 ToolJet can connect to **Amazon S3** buckets and perform various operation on them. -
+
## Connection @@ -49,7 +49,7 @@ You can now connect to **[different S3 Hosts using custom endpoints](/docs/how-t
-
+
## Querying AWS S3 @@ -69,7 +69,7 @@ Query results can be transformed using transformations. Read our [transformation
-
+
## Query operations @@ -85,8 +85,6 @@ You can create query for AWS S3 data source to perform several actions such as:
-
- ### Create a new bucket You can create a new bucket in your S3 by using this operation. @@ -101,10 +99,6 @@ You can create a new bucket in your S3 by using this operation.
-
- -
- ### Read object You can read an object in a bucket by using this operation. @@ -116,13 +110,9 @@ You can read an object in a bucket by using this operation.
- aws s3 read object + aws s3 read object
-
- -
- ### Upload object You can use this operation to upload objects(files) to your S3 bucket. @@ -136,13 +126,9 @@ You can use this operation to upload objects(files) to your S3 bucket.
- aws s3 upload + aws s3 upload
-
- -
- ### Remove object You can use this operation to remove an object from your S3 bucket. @@ -154,27 +140,19 @@ You can use this operation to remove an object from your S3 bucket.
- Create a new bucket - S3 operation + Create a new bucket - S3 operation
-
- -
- ### List buckets This operation will list all the buckets in your S3. This does not require any parameter.
- aws s3 bucket + aws s3 bucket
-
- -
- ### List objects in a bucket This operation will fetch the list of all the files in your bucket. It requires the following parameters: @@ -202,14 +180,10 @@ The results will continue from where the last listing finished.
-aws s3 list object +aws s3 list object
-
- -
- ### Signed url for download The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects. @@ -223,15 +197,10 @@ The object owner can optionally share objects with others by creating a presigne
-aws s3 signed download +aws s3 signed download
-
- -
- - ### Signed url for upload The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions. @@ -254,6 +223,4 @@ The presigned URLs are useful if you want your user/customer to be able to uploa :::info We built an app to view and upload files to AWS S3 buckets. Check out the complete tutorial **[here](https://blog.tooljet.com/build-an-aws-s3-broswer-with-tooljet/)**. -::: - -
\ No newline at end of file +::: \ No newline at end of file diff --git a/docs/versioned_docs/version-2.65.0/data-sources/airtable.md b/docs/versioned_docs/version-2.65.0/data-sources/airtable.md index dadae4beb1..c6e581b58e 100644 --- a/docs/versioned_docs/version-2.65.0/data-sources/airtable.md +++ b/docs/versioned_docs/version-2.65.0/data-sources/airtable.md @@ -2,7 +2,6 @@ id: airtable title: Airtable --- -
ToolJet can connect to your **Airtable** account to read and write data. **Personal Access Token** is required to connect to the Airtable data source on ToolJet. You can generate the Personal Access Token by visiting **[Developer Hub from your Airtable profile](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens#understanding-personal-access-token-basic-actions)**. @@ -16,9 +15,7 @@ ToolJet can connect to your **Airtable** account to read and write data. **Perso Airtable API has a rate limit, and at the time of writing this documentation, the limit is five(5) requests per second per base. You can read more about rate limits here **[Airtable API](https://airtable.com/api)**. ::: -
- -
+
## Supported Operations @@ -30,7 +27,7 @@ Airtable API has a rate limit, and at the time of writing this documentation, th
-
+
### List records @@ -41,7 +38,6 @@ This operation returns a list of records from the specified table. - **Base ID:** To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd` - **Table name:** The name of the table from which you want to fetch the records. -
#### Optional parameters: - **Page size:** The number of records returned in each request. Default is 100 records. @@ -90,8 +86,6 @@ Example response from Airtable:
-
- ### Retrieve record #### Required parameters: @@ -118,10 +112,6 @@ Example response from Airtable: } ``` -
- -
- ### Create record #### Required parameters: @@ -163,10 +153,6 @@ Query returns the following response when the record is created successfully: } ``` -
- -
- ### Update record #### Required parameters: @@ -206,10 +192,6 @@ Query returns the following response when the record is updated successfully: } ``` -
- -
- ### Delete record #### Required parameters: @@ -229,5 +211,4 @@ Query returns the following response when the record is deleted successfully: deleted: true id: "recIKsyZgqI4zoqS7" } -``` -
\ No newline at end of file +``` \ No newline at end of file diff --git a/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md b/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md index a75d5b70fa..13a9cc0d34 100644 --- a/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md +++ b/docs/versioned_docs/version-2.65.0/data-sources/amazonses.md @@ -5,7 +5,7 @@ title: Amazon SES ToolJet can connect to your Amazon SES account to send emails. -
+
## Connection To add a new **Amazon SES** API data source, click the **Data sources** icon on the left-sidebar of the app builder and click on the **+Add** button, then select Amazon SES from the modal that pops up. @@ -28,10 +28,9 @@ Click on the **Save** button to save the data source.
-
+
## Supported operations -1. Email service ### Email service Required parameters: diff --git a/docs/versioned_docs/version-2.65.0/data-sources/s3.md b/docs/versioned_docs/version-2.65.0/data-sources/s3.md index 06c1541543..d27f3205ed 100644 --- a/docs/versioned_docs/version-2.65.0/data-sources/s3.md +++ b/docs/versioned_docs/version-2.65.0/data-sources/s3.md @@ -5,7 +5,7 @@ title: Amazon S3 ToolJet can connect to **Amazon S3** buckets and perform various operation on them. -
+
## Connection @@ -49,7 +49,7 @@ You can now connect to **[different S3 Hosts using custom endpoints](/docs/how-t
-
+
## Querying AWS S3 @@ -69,7 +69,7 @@ Query results can be transformed using transformations. Read our [transformation
-
+
## Query operations @@ -85,8 +85,6 @@ You can create query for AWS S3 data source to perform several actions such as:
-
- ### Create a new bucket You can create a new bucket in your S3 by using this operation. @@ -101,10 +99,6 @@ You can create a new bucket in your S3 by using this operation.
-
- -
- ### Read object You can read an object in a bucket by using this operation. @@ -116,13 +110,9 @@ You can read an object in a bucket by using this operation.
- aws s3 read object + aws s3 read object
-
- -
- ### Upload object You can use this operation to upload objects(files) to your S3 bucket. @@ -136,13 +126,9 @@ You can use this operation to upload objects(files) to your S3 bucket.
- aws s3 upload + aws s3 upload
-
- -
- ### Remove object You can use this operation to remove an object from your S3 bucket. @@ -154,27 +140,19 @@ You can use this operation to remove an object from your S3 bucket.
- Create a new bucket - S3 operation + Create a new bucket - S3 operation
-
- -
- ### List buckets This operation will list all the buckets in your S3. This does not require any parameter.
- aws s3 bucket + aws s3 bucket
-
- -
- ### List objects in a bucket This operation will fetch the list of all the files in your bucket. It requires the following parameters: @@ -202,14 +180,10 @@ The results will continue from where the last listing finished.
-aws s3 list object +aws s3 list object
-
- -
- ### Signed url for download The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects. @@ -223,15 +197,10 @@ The object owner can optionally share objects with others by creating a presigne
-aws s3 signed download +aws s3 signed download
-
- -
- - ### Signed url for upload The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions. @@ -254,6 +223,4 @@ The presigned URLs are useful if you want your user/customer to be able to uploa :::info We built an app to view and upload files to AWS S3 buckets. Check out the complete tutorial **[here](https://blog.tooljet.com/build-an-aws-s3-broswer-with-tooljet/)**. -::: - -
\ No newline at end of file +::: \ No newline at end of file From 4294127d365bc94ffbd74148f19fc223971ece05 Mon Sep 17 00:00:00 2001 From: Pratik Agrawal Date: Mon, 9 Sep 2024 10:46:11 +0530 Subject: [PATCH 3/3] [docs]: Update data-sources guides - airtable, amazon s3, amazon ses --- docs/docs/data-sources/s3.md | 4 ++-- docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md | 4 ++-- docs/versioned_docs/version-2.65.0/data-sources/s3.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/docs/data-sources/s3.md b/docs/docs/data-sources/s3.md index 8bc4ebce4a..5e1687146c 100644 --- a/docs/docs/data-sources/s3.md +++ b/docs/docs/data-sources/s3.md @@ -184,7 +184,7 @@ The results will continue from where the last listing finished.
-### Signed url for download +### Signed URL for download The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects. @@ -201,7 +201,7 @@ The object owner can optionally share objects with others by creating a presigne
-### Signed url for upload +### Signed URL for upload The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions. diff --git a/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md b/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md index d27f3205ed..08bd5c07e0 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md +++ b/docs/versioned_docs/version-2.50.0-LTS/data-sources/s3.md @@ -184,7 +184,7 @@ The results will continue from where the last listing finished.
-### Signed url for download +### Signed URL for download The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects. @@ -201,7 +201,7 @@ The object owner can optionally share objects with others by creating a presigne
-### Signed url for upload +### Signed URL for upload The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions. diff --git a/docs/versioned_docs/version-2.65.0/data-sources/s3.md b/docs/versioned_docs/version-2.65.0/data-sources/s3.md index d27f3205ed..08bd5c07e0 100644 --- a/docs/versioned_docs/version-2.65.0/data-sources/s3.md +++ b/docs/versioned_docs/version-2.65.0/data-sources/s3.md @@ -184,7 +184,7 @@ The results will continue from where the last listing finished.
-### Signed url for download +### Signed URL for download The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects. @@ -201,7 +201,7 @@ The object owner can optionally share objects with others by creating a presigne
-### Signed url for upload +### Signed URL for upload The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions.