Skip to content

Commit fc35c03

Browse files
darynaishchenkodarynaishchenko
authored
fix(connectors docs): updated connectors to follow standard template (#39328)
1 parent 6cf3e83 commit fc35c03

23 files changed

+770
-461
lines changed

‎docs/integrations/sources/airtable.md

+18-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Airtable
22

3+
<HideInUI>
4+
35
This page contains the setup guide and reference information for the [Airtable](https://airtable.com/api) source connector.
46

7+
</HideInUI>
8+
59
## Prerequisites
610

711
- An active Airtable account
@@ -40,24 +44,25 @@ This page contains the setup guide and reference information for the [Airtable](
4044
### For Airbyte Cloud:
4145

4246
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
43-
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
44-
3. On the Set up the source page, enter the name for the Airtable connector and select **Airtable** from the Source type dropdown.
45-
4. You can use OAuth or a Personal Access Token to authenticate your Airtable account. We recommend using OAuth for Airbyte Cloud.
47+
2. Click Sources and then click + New source.
48+
3. On the Set up the source page, select Airtable from the Source type dropdown.
49+
4. Enter a name for the Airtable connector.
50+
5. You can use OAuth or a Personal Access Token to authenticate your Airtable account. We recommend using OAuth for Airbyte Cloud.
4651

4752
- To authenticate using OAuth, select **OAuth2.0** from the Authentication dropdown click **Authenticate your Airtable account** to sign in with Airtable, select required workspaces you want to sync and authorize your account.
4853
- To authenticate using a Personal Access Token, select **Personal Access Token** from the Authentication dropdown and enter the Access Token for your Airtable account.
4954
:::info
5055
When using OAuth, you may see a `400` or `401` error causing a failed sync. You can re-authenticate your Airtable connector to solve the issue temporarily. We are working on a permanent fix that you can follow [here](https://github.com/airbytehq/airbyte/issues/25278).
5156
:::
5257

53-
5. Click **Set up source**.
58+
6. Click **Set up source**.
5459
<!-- /env:cloud -->
5560

5661
<!-- env:oss -->
5762

58-
### For Airbyte OSS:
63+
### For Airbyte Open Source:
5964

60-
1. Navigate to the Airbyte Open Source dashboard
65+
1. Navigate to the Airbyte Open Source dashboard.
6166
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
6267
3. On the Set up the source page, enter the name for the Airtable connector and select **Airtable** from the Source type dropdown.
6368
4. Select **Personal Access Token** from the Authentication dropdown and enter the Access Token for your Airtable account.
@@ -70,12 +75,12 @@ Please keep in mind that if you start syncing a table via Airbyte, then rename i
7075

7176
## Supported sync modes
7277

73-
The airtable source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
78+
The Airtable source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):
7479

7580
- [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/glossary#full-refresh-sync)
7681
- [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append)
7782

78-
## Supported Tables
83+
## Supported Streams
7984

8085
This source allows you to pull all available tables and bases using `Metadata API` for a given authenticated user. In case you rename or add a column to any existing table, you will need to recreate the source to update the Airbyte catalog.
8186

@@ -127,6 +132,9 @@ See information about rate limits [here](https://airtable.com/developers/web/api
127132

128133
## Changelog
129134

135+
<details>
136+
<summary>Expand to review</summary>
137+
130138
| Version | Date | Pull Request | Subject |
131139
|:--------|:-----------| :------------------------------------------------------- |:---------------------------------------------------------------------------------------|
132140
| 4.4.0 | 2024-07-16 | [41160](https://github.com/airbytehq/airbyte/pull/41160) | Update CDK version to v3.5.2 |
@@ -160,3 +168,5 @@ See information about rate limits [here](https://airtable.com/developers/web/api
160168
| 0.1.3 | 2022-10-26 | [18491](https://github.com/airbytehq/airbyte/pull/18491) | Improve schema discovery logic |
161169
| 0.1.2 | 2022-04-30 | [12500](https://github.com/airbytehq/airbyte/pull/12500) | Improve input configuration copy |
162170
| 0.1.1 | 2021-12-06 | [8425](https://github.com/airbytehq/airbyte/pull/8425) | Update title, description fields in spec |
171+
172+
</details>

‎docs/integrations/sources/amazon-ads.md

+30-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Amazon Ads
22

3-
This page contains the setup guide and reference information for the Amazon Ads source connector.
3+
<HideInUI>
4+
5+
This page contains the setup guide and reference information for the [Amazon Ads](https://advertising.amazon.com) source connector.
6+
7+
</HideInUI>
48

59
## Prerequisites
610

@@ -29,13 +33,30 @@ To use the [Amazon Ads API](https://advertising.amazon.com/API/docs/en-us), you
2933

3034
<!-- env:cloud -->
3135

32-
**For Airbyte Cloud:**
36+
#### For Airbyte Cloud:
3337

3438
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
35-
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**.
36-
3. On the source setup page, select **Amazon Ads** from the Source type dropdown and enter a name for this connector.
37-
4. Click **Authenticate your Amazon Ads account**.
38-
5. Log in and Authorize to the Amazon account.
39+
2. Click Sources and then click + New source.
40+
3. On the Set up the source page, select Amazon Ads from the Source type dropdown.
41+
4. Enter a name for the Amazon Ads connector.
42+
5. Click **Authenticate your Amazon Ads account**.
43+
6. Log in and Authorize to the Amazon account.
44+
7. Select **Region** to pull data from **North America (NA)**, **Europe (EU)**, **Far East (FE)**. See [docs](https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints) for more details.
45+
8. **Start Date (Optional)** is used for generating reports starting from the specified start date. This should be in YYYY-MM-DD format and not more than 60 days in the past. If a date is not specified, today's date is used. The date is treated in the timezone of the processed profile.
46+
9. **Profile IDs (Optional)** you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See [docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details.
47+
10. **Marketplace IDs (Optional)** you want to fetch data for. _Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID **OR** the Marketplace ID._
48+
11. Click **Set up source**.
49+
<!-- /env:cloud -->
50+
51+
<!-- env:oss -->
52+
53+
#### For Airbyte Open Source:
54+
55+
1. Navigate to the Airbyte Open Source dashboard.
56+
2. Set the name for your source.
57+
3. **Client ID** of your Amazon Ads developer application. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details.
58+
4. **Client Secret** of your Amazon Ads developer application. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details.
59+
5. **Refresh Token**. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details.
3960
6. Select **Region** to pull data from **North America (NA)**, **Europe (EU)**, **Far East (FE)**. See [docs](https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints) for more details.
4061
7. **Start Date (Optional)** is used for generating reports starting from the specified start date. This should be in YYYY-MM-DD format and not more than 60 days in the past. If a date is not specified, today's date is used. The date is treated in the timezone of the processed profile.
4162
8. **Profile IDs (Optional)** you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See [docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details.
@@ -63,7 +84,7 @@ If you have only agency profile, please use accounts associated with the profile
6384

6485
## Supported sync modes
6586

66-
The Amazon Ads source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-mode):
87+
The Amazon Ads source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):
6788

6889
- Full Refresh
6990
- Incremental
@@ -114,7 +135,7 @@ Report data synchronization only covers the last 60 days - [details](https://adv
114135

115136
Information about expected report generation waiting time can be found [here](https://advertising.amazon.com/API/docs/en-us/get-started/developer-notes).
116137

117-
### Data type mapping
138+
### Data type map
118139

119140
| Integration Type | Airbyte Type |
120141
| :----------------------- | :----------- |
@@ -157,7 +178,7 @@ Information about expected report generation waiting time can be found [here](ht
157178
| 3.2.0 | 2023-09-18 | [30517](https://github.com/airbytehq/airbyte/pull/30517) | Add suggested streams; fix unexpected column issue |
158179
| 3.1.2 | 2023-08-16 | [29233](https://github.com/airbytehq/airbyte/pull/29233) | Add filter for Marketplace IDs |
159180
| 3.1.1 | 2023-08-28 | [29900](https://github.com/airbytehq/airbyte/pull/29900) | Add 404 handling for no associated with bid ad groups |
160-
| 3.1.0 | 2023-08-08 | [00000](https://github.com/airbytehq/airbyte/pull/00000) | Add `T00030` tactic support for `sponsored_display_report_stream` |
181+
| 3.1.0 | 2023-08-08 | [29212](https://github.com/airbytehq/airbyte/pull/29212) | Add `T00030` tactic support for `sponsored_display_report_stream` |
161182
| 3.0.0 | 2023-07-24 | [27868](https://github.com/airbytehq/airbyte/pull/27868) | Fix attribution report stream schemas |
162183
| 2.3.1 | 2023-07-11 | [28155](https://github.com/airbytehq/airbyte/pull/28155) | Bugfix: validation error when record values are missing |
163184
| 2.3.0 | 2023-07-06 | [28002](https://github.com/airbytehq/airbyte/pull/28002) | Add sponsored_product_ad_group_suggested_keywords, sponsored_product_ad_group_bid_recommendations streams |

‎docs/integrations/sources/azure-blob-storage.md

+46-13
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Azure Blob Storage
22

3-
This page contains the setup guide and reference information for the Azure Blob Storage source connector.
3+
<HideInUI>
4+
5+
This page contains the setup guide and reference information for the [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/?product=popular) source connector.
6+
7+
</HideInUI>
48

59
:::info
610
Cloud storage may incur egress costs. Egress refers to data that is transferred out of the cloud storage system, such as when you download files or access them from a different location. For more information, see the [Azure Blob Storage pricing guide](https://azure.microsoft.com/en-us/pricing/details/storage/blobs/).
@@ -60,25 +64,52 @@ Follow these steps to set up an IAM role:
6064

6165
### Step 2: Set up the Azure Blob Storage connector in Airbyte
6266

63-
1. [Log in to your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account, or navigate to your Airbyte Open Source dashboard.
64-
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**.
65-
3. Find and select **Azure Blob Storage** from the list of available sources.
66-
4. Enter the name of your Azure **Account**.
67-
5. Enter your Tenant ID and Click **Authenticate your Azure Blob Storage account**.
68-
6. Log in and authorize the Azure Blob Storage account.
69-
7. Enter the name of the **Container** containing your files to replicate.
70-
8. Add a stream
67+
<!-- env:cloud -->
68+
69+
### For Airbyte Cloud:
70+
71+
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
72+
2. Click Sources and then click + New source.
73+
3. On the Set up the source page, select Azure Blob Storage from the Source type dropdown.
74+
4. Enter a name for the Azure Blob Storage connector.
75+
5. Enter the name of your Azure **Account**.
76+
6. Enter your Tenant ID and Click **Authenticate your Azure Blob Storage account**.
77+
7. Log in and authorize the Azure Blob Storage account.
78+
8. Enter the name of the **Container** containing your files to replicate.
79+
9. Add a stream
80+
1. Write the **File Type**
81+
2. In the **Format** box, use the dropdown menu to select the format of the files you'd like to replicate. The supported formats are **CSV**, **Parquet**, **Avro** and **JSONL**. Toggling the **Optional fields** button within the **Format** box will allow you to enter additional configurations based on the selected format. For a detailed breakdown of these settings, refer to the [File Format section](#file-format-settings) below.
82+
3. Give a **Name** to the stream
83+
4. (Optional)—If you want to enforce a specific schema, you can enter a **Input schema**. By default, this value is set to `{}` and will automatically infer the schema from the file\(s\) you are replicating. For details on providing a custom schema, refer to the [User Schema section](#user-schema).
84+
5. Optionally, enter the **Globs** which dictates which files to be synced. This is a regular expression that allows Airbyte to pattern match the specific files to replicate. If you are replicating all the files within your bucket, use `**` as the pattern. For more precise pattern matching options, refer to the [Path Patterns section](#path-patterns) below.
85+
10. (Optional) Enter the endpoint to use for the data replication.
86+
11. (Optional) Enter the desired start date from which to begin replicating data.
87+
<!-- /env:cloud -->
88+
89+
<!-- env:oss -->
90+
### For Airbyte Open Source:
91+
92+
1. Navigate to the Airbyte Open Source dashboard.
93+
2. Click Sources and then click + New source.
94+
3. On the Set up the source page, select Azure Blob Storage from the Source type dropdown.
95+
4. Enter a name for the Azure Blob Storage connector.
96+
5. Enter the name of your Azure **Account**.
97+
6. Enter your Tenant ID and Click **Authenticate your Azure Blob Storage account**.
98+
7. Log in and authorize the Azure Blob Storage account.
99+
8. Enter the name of the **Container** containing your files to replicate.
100+
9. Add a stream
71101
1. Write the **File Type**
72102
2. In the **Format** box, use the dropdown menu to select the format of the files you'd like to replicate. The supported formats are **CSV**, **Parquet**, **Avro** and **JSONL**. Toggling the **Optional fields** button within the **Format** box will allow you to enter additional configurations based on the selected format. For a detailed breakdown of these settings, refer to the [File Format section](#file-format-settings) below.
73103
3. Give a **Name** to the stream
74104
4. (Optional)—If you want to enforce a specific schema, you can enter a **Input schema**. By default, this value is set to `{}` and will automatically infer the schema from the file\(s\) you are replicating. For details on providing a custom schema, refer to the [User Schema section](#user-schema).
75105
5. Optionally, enter the **Globs** which dictates which files to be synced. This is a regular expression that allows Airbyte to pattern match the specific files to replicate. If you are replicating all the files within your bucket, use `**` as the pattern. For more precise pattern matching options, refer to the [Path Patterns section](#path-patterns) below.
76-
9. (Optional) Enter the endpoint to use for the data replication.
77-
10. (Optional) Enter the desired start date from which to begin replicating data.
106+
10. (Optional) Enter the endpoint to use for the data replication.
107+
11. (Optional) Enter the desired start date from which to begin replicating data.
108+
<!-- /env:oss -->
78109

79-
## Supported Streams
110+
## Supported sync modes
80111

81-
The Azure Blob Storage source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
112+
The Azure Blob Storage source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):
82113

83114
| Feature | Supported? |
84115
| :--------------------------------------------- | :--------- |
@@ -89,6 +120,8 @@ The Azure Blob Storage source connector supports the following [sync modes](http
89120
| Replicate Multiple Streams \(distinct tables\) | Yes |
90121
| Namespaces | No |
91122

123+
## Supported Streams
124+
92125
### File Compressions
93126

94127
| Compression | Supported? |

0 commit comments

Comments
 (0)