Skip to content

Commit 9879a81

Browse files
lazebnyilazebnyi
authored
Updated docs to teamplate (#15842)
1 parent e1f294c commit 9879a81

File tree

9 files changed

+488
-386
lines changed

9 files changed

+488
-386
lines changed

‎docs/integrations/sources/asana.md

Lines changed: 48 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,40 @@
11
# Asana
22

3-
## Sync overview
3+
This page contains the setup guide and reference information for the Asana source connector.
44

5-
This source can sync data for the [Asana API](https://developers.asana.com/docs). It supports only Full Refresh syncs.
5+
## Prerequisites
66

7-
### Output schema
7+
Please follow these [steps](https://developers.asana.com/docs/personal-access-token) to obtain Personal Access Token for your account.
8+
9+
## Setup guide
10+
## Step 1: Set up the Asana connector in Airbyte
11+
12+
### For Airbyte Cloud:
13+
14+
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
15+
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
16+
3. On the Set up the source page, enter the name for the Asana connector and select **Asana** from the Source type dropdown.
17+
4. Select `Authenticate your account`.
18+
5. Log in and Authorize to the Asana account and click `Set up source`.
19+
20+
### For Airbyte OSS:
821

9-
This Source is capable of syncing the following Streams:
22+
1. Navigate to the Airbyte Open Source dashboard
23+
2. Set the name for your source
24+
3. Enter your `personal_access_token`
25+
4. Click **Set up source**
26+
27+
## Supported sync modes
28+
29+
The Asana source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
30+
31+
| Feature | Supported? |
32+
| :---------------- | :--------- |
33+
| Full Refresh Sync | Yes |
34+
| Incremental Sync | No |
35+
| Namespaces | No |
36+
37+
## Supported Streams
1038

1139
* [Custom fields](https://developers.asana.com/docs/custom-fields)
1240
* [Projects](https://developers.asana.com/docs/projects)
@@ -19,47 +47,26 @@ This Source is capable of syncing the following Streams:
1947
* [Users](https://developers.asana.com/docs/users)
2048
* [Workspaces](https://developers.asana.com/docs/workspaces)
2149

22-
### Data type mapping
23-
24-
| Integration Type | Airbyte Type | Notes |
25-
| :--- | :--- | :--- |
26-
| `string` | `string` | |
27-
| `int`, `float`, `number` | `number` | |
28-
| `date` | `date` | |
29-
| `datetime` | `datetime` | |
30-
| `array` | `array` | |
31-
| `object` | `object` | |
32-
33-
### Features
34-
35-
| Feature | Supported?\(Yes/No\) | Notes |
36-
| :--- | :--- | :--- |
37-
| Full Refresh Sync | Yes | |
38-
| Incremental Sync | No | |
39-
| Namespaces | No | |
40-
41-
### Performance considerations
50+
## Performance considerations
4251

4352
The connector is restricted by normal Asana [requests limitation](https://developers.asana.com/docs/rate-limits).
4453

45-
The Asana connector should not run into Asana API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
46-
47-
## Getting started
48-
49-
### Requirements
54+
## Data type map
5055

51-
* Personal Access Token
52-
53-
### Setup guide
54-
55-
Please follow these [steps](https://developers.asana.com/docs/personal-access-token) to obtain Personal Access Token for your account.
56+
| Integration Type | Airbyte Type |
57+
| :----------------------- | :----------- |
58+
| `string` | `string` |
59+
| `int`, `float`, `number` | `number` |
60+
| `date` | `date` |
61+
| `datetime` | `datetime` |
62+
| `array` | `array` |
63+
| `object` | `object` |
5664

5765
## Changelog
5866

59-
| Version | Date | Pull Request | Subject |
60-
| :--- | :--- | :--- | :--- |
61-
| 0.1.3 | 2021-10-06 | | Add oauth init flow parameters support |
62-
| 0.1.2 | 2021-09-24 | [6402](https://github.com/airbytehq/airbyte/pull/6402) | Fix SAT tests: update schemas and invalid\_config.json file |
63-
| 0.1.1 | 2021-06-09 | [3973](https://github.com/airbytehq/airbyte/pull/3973) | Add entrypoint and bump version for connector |
64-
| 0.1.0 | 2021-05-25 | [3510](https://github.com/airbytehq/airbyte/pull/3510) | New Source: Asana |
65-
67+
| Version | Date | Pull Request | Subject |
68+
| :------ | :--------- | :------------------------------------------------------- | :---------------------------------------------------------- |
69+
| 0.1.3 | 2021-10-06 | [15749](https://github.com/airbytehq/airbyte/pull/15749) | Add oauth init flow parameters support |
70+
| 0.1.2 | 2021-09-24 | [6402](https://github.com/airbytehq/airbyte/pull/6402) | Fix SAT tests: update schemas and invalid\_config.json file |
71+
| 0.1.1 | 2021-06-09 | [3973](https://github.com/airbytehq/airbyte/pull/3973) | Add entrypoint and bump version for connector |
72+
| 0.1.0 | 2021-05-25 | [3510](https://github.com/airbytehq/airbyte/pull/3510) | New Source: Asana |

‎docs/integrations/sources/greenhouse.md

Lines changed: 38 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,42 @@
11
# Greenhouse
22

3-
## Overview
3+
This page contains the setup guide and reference information for the Greenhouse source connector.
44

5-
The Greenhouse source supports Full Refresh syncs. That is, every time a sync is run, Airbyte will copy all rows in the tables and columns you set up for replication into the destination in a new table.
5+
## Prerequisites
66

7-
### Output schema
7+
Please follow the [Greenhouse documentation for generating an API key](https://developers.greenhouse.io/harvest.html#authentication).
8+
9+
## Setup guide
10+
## Step 1: Set up the Greenhouse connector in Airbyte
11+
12+
### For Airbyte Cloud:
13+
14+
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
15+
2. In the left navigation bar, click **Source**. In the top-right corner, click **+new source**.
16+
3. On the Set up the source page, enter the name for the Greenhouse connector and select **Greenhouse** from the Source type dropdown.
17+
4. Enter your `api_key`
18+
5. Click **Set up source**
19+
20+
### For Airbyte OSS:
21+
22+
1. Navigate to the Airbyte Open Source dashboard
23+
2. Set the name for your source
24+
3. Enter your `api_key`
25+
4. Click **Set up source**
26+
27+
## Supported sync modes
28+
29+
The Greenhouse source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
30+
31+
| Feature | Supported? |
32+
| :---------------------------- | :---------- |
33+
| Full Refresh Sync | Yes |
34+
| Incremental Sync | Coming soon |
35+
| Replicate Incremental Deletes | Coming soon |
36+
| SSL connection | Yes |
37+
| Namespaces | No |
838

9-
Several output streams are available from this source:
39+
## Supported Streams
1040

1141
* [Applications](https://developers.greenhouse.io/harvest.html#get-list-applications)
1242
* [Applications Interviews](https://developers.greenhouse.io/harvest.html#get-list-scheduled-interviews-for-application)
@@ -27,31 +57,10 @@ Several output streams are available from this source:
2757
* [Sources](https://developers.greenhouse.io/harvest.html#get-list-sources)
2858
* [Users](https://developers.greenhouse.io/harvest.html#get-list-users)
2959

30-
If there are more endpoints you'd like Airbyte to support, please [create an issue.](https://github.com/airbytehq/airbyte/issues/new/choose)
60+
## Performance considerations
3161

32-
### Features
33-
34-
| Feature | Supported? |
35-
| :--- | :--- |
36-
| Full Refresh Sync | Yes |
37-
| Incremental Sync | Coming soon |
38-
| Replicate Incremental Deletes | Coming soon |
39-
| SSL connection | Yes |
40-
| Namespaces | No |
41-
42-
### Performance considerations
43-
44-
The Greenhouse connector should not run into Greenhouse API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
45-
46-
## Getting started
47-
48-
### Requirements
49-
50-
* Greenhouse API Key
51-
52-
### Setup guide
53-
54-
Please follow the [Greenhouse documentation for generating an API key](https://developers.greenhouse.io/harvest.html#authentication).
62+
The Greenhouse connector should not run into Greenhouse API limitations under normal usage.
63+
Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
5564

5665
## Changelog
5766

@@ -61,4 +70,4 @@ Please follow the [Greenhouse documentation for generating an API key](https://d
6170
| 0.2.7 | 2022-04-15 | [11941](https://github.com/airbytehq/airbyte/pull/11941) | Correct Schema data type for Applications, Candidates, Scorecards and Users |
6271
| 0.2.6 | 2021-11-08 | [7607](https://github.com/airbytehq/airbyte/pull/7607) | Implement demographics streams support. Update SAT for demographics streams |
6372
| 0.2.5 | 2021-09-22 | [6377](https://github.com/airbytehq/airbyte/pull/6377) | Refactor the connector to use CDK. Implement additional stream support |
64-
| 0.2.4 | 2021-09-15 | [6238](https://github.com/airbytehq/airbyte/pull/6238) | added identification of accessible streams for API keys with limited permissions |
73+
| 0.2.4 | 2021-09-15 | [6238](https://github.com/airbytehq/airbyte/pull/6238) | Add identification of accessible streams for API keys with limited permissions |

‎docs/integrations/sources/iterable.md

Lines changed: 66 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,81 @@
11
# Iterable
22

3-
## Overview
3+
This page contains the setup guide and reference information for the <connector name> <source/destination> connector.
44

5-
The Iterable supports full refresh and incremental sync.
5+
## Prerequisites
66

7-
This source can sync data for the [Iterable API](https://api.iterable.com/api/docs).
8-
9-
### Output schema
10-
11-
Several output streams are available from this source:
12-
13-
* [Campaigns](https://api.iterable.com/api/docs#campaigns_campaigns)
14-
* [Campaign Metrics](https://api.iterable.com/api/docs#campaigns_metrics)
15-
* [Channels](https://api.iterable.com/api/docs#channels_channels)
16-
* [Email Bounce](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
17-
* [Email Click](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
18-
* [Email Complaint](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
19-
* [Email Open](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
20-
* [Email Send](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
21-
* [Email Send Skip](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
22-
* [Email Subscribe](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
23-
* [Email Unsubscribe](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
24-
* [Events](https://api.iterable.com/api/docs#events_User_events)
25-
* [Lists](https://api.iterable.com/api/docs#lists_getLists)
26-
* [List Users](https://api.iterable.com/api/docs#lists_getLists_0)
27-
* [Message Types](https://api.iterable.com/api/docs#messageTypes_messageTypes)
28-
* [Metadata](https://api.iterable.com/api/docs#metadata_list_tables)
29-
* [Templates](https://api.iterable.com/api/docs#templates_getTemplates) \(Incremental sync\)
30-
* [Users](https://api.iterable.com/api/docs#export_exportDataJson) \(Incremental sync\)
31-
32-
If there are more endpoints you'd like Airbyte to support, please [create an issue.](https://github.com/airbytehq/airbyte/issues/new/choose)
7+
* Iterable Account
8+
* Iterable API Key with `standard` permissions. See [API Keys docs](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-) for more details.
339

34-
### Features
10+
## Setup guide
11+
### Step 1: Set up Iterable
3512

36-
| Feature | Supported? |
37-
| :--- | :--- |
38-
| Full Refresh Sync | Yes |
39-
| Incremental Sync | Yes |
40-
| SSL connection | Yes |
13+
Please read [How to find your API key](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-#creating-api-keys).
4114

42-
### Performance considerations
15+
## Step 2: Set up the Iterable connector in Airbyte
16+
### For Airbyte Cloud:
4317

44-
The Iterable connector should not run into Iterable API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
18+
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
19+
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
20+
3. On the Set up the source page, enter the name for the Iterable connector and select **Iterable** from the Source type dropdown.
21+
4. Enter your `api_key`
22+
5. Enter the `start_date` you want your sync to start from
23+
6. Click **Set up source**
4524

46-
## Getting started
25+
### For Airbyte OSS:
4726

48-
### Requirements
27+
1. Navigate to the Airbyte Open Source dashboard
28+
2. Set the name for your source
29+
3. Enter your `api_key`
30+
4. Enter the `start_date` you want your sync to start from
31+
5. Click **Set up source**
4932

50-
* Iterable Account
51-
* Iterable API Key with `standard` permissions. See [API Keys docs](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-) for more details.
33+
## Supported sync modes
5234

53-
### Setup guide
54-
<!-- markdown-link-check-disable-next-line -->
55-
Please read [How to find your API key](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-#creating-api-keys).
35+
The Iterable <source/destination> connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
5636

57-
## CHANGELOG
37+
| Feature | Supported? |
38+
| :---------------- | :--------- |
39+
| Full Refresh Sync | Yes |
40+
| Incremental Sync | Yes |
41+
| SSL connection | Yes |
5842

59-
| Version | Date | Pull Request | Subject |
60-
| :------ | :-------- | :----- | :------ |
61-
| `0.1.15` | 2021-12-06 | [8524](https://github.com/airbytehq/airbyte/pull/8524) | Update connector fields title/description |
62-
| `0.1.14` | 2021-12-01 | [8380](https://github.com/airbytehq/airbyte/pull/8380) | Update `Events` stream to use `export/userEvents` endpoint |
63-
| `0.1.13` | 2021-11-22 | [8091](https://github.com/airbytehq/airbyte/pull/8091) | Adjust slice ranges for email streams |
64-
| `0.1.12` | 2021-11-09 | [7780](https://github.com/airbytehq/airbyte/pull/7780) | Split EmailSend stream into slices to fix premature connection close error |
65-
| `0.1.11` | 2021-11-03 | [7619](https://github.com/airbytehq/airbyte/pull/7619) | Bugfix type error while incrementally loading the `Templates` stream |
66-
| `0.1.10` | 2021-11-03 | [7591](https://github.com/airbytehq/airbyte/pull/7591) | Optimize export streams memory consumption for large requests |
67-
| `0.1.9` | 2021-10-06 | [5915](https://github.com/airbytehq/airbyte/pull/5915) | Enable campaign_metrics stream |
68-
| `0.1.8` | 2021-09-20 | [5915](https://github.com/airbytehq/airbyte/pull/5915) | Add new streams: campaign_metrics, events |
69-
| `0.1.7` | 2021-09-20 | [6242](https://github.com/airbytehq/airbyte/pull/6242) | Updated schema for: campaigns, lists, templates, metadata |
43+
## Supported Streams
7044

45+
* [Campaigns](https://api.iterable.com/api/docs#campaigns_campaigns)
46+
* [Campaign Metrics](https://api.iterable.com/api/docs#campaigns_metrics)
47+
* [Channels](https://api.iterable.com/api/docs#channels_channels)
48+
* [Email Bounce](https://api.iterable.com/api/docs#export_exportDataJson)
49+
* [Email Click](https://api.iterable.com/api/docs#export_exportDataJson)
50+
* [Email Complaint](https://api.iterable.com/api/docs#export_exportDataJson)
51+
* [Email Open](https://api.iterable.com/api/docs#export_exportDataJson)
52+
* [Email Send](https://api.iterable.com/api/docs#export_exportDataJson)
53+
* [Email Send Skip](https://api.iterable.com/api/docs#export_exportDataJson)
54+
* [Email Subscribe](https://api.iterable.com/api/docs#export_exportDataJson)
55+
* [Email Unsubscribe](https://api.iterable.com/api/docs#export_exportDataJson)
56+
* [Events](https://api.iterable.com/api/docs#events_User_events)
57+
* [Lists](https://api.iterable.com/api/docs#lists_getLists)
58+
* [List Users](https://api.iterable.com/api/docs#lists_getLists_0)
59+
* [Message Types](https://api.iterable.com/api/docs#messageTypes_messageTypes)
60+
* [Metadata](https://api.iterable.com/api/docs#metadata_list_tables)
61+
* [Templates](https://api.iterable.com/api/docs#templates_getTemplates)
62+
* [Users](https://api.iterable.com/api/docs#export_exportDataJson)
63+
64+
## Performance considerations
65+
66+
The Iterable connector should not run into Iterable API limitations under normal usage.
67+
Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
68+
69+
## Changelog
70+
71+
| Version | Date | Pull Request | Subject |
72+
| :------ | :--------- | :----------------------------------------------------- | :------------------------------------------------------------------------- |
73+
| 0.1.15 | 2021-12-06 | [8524](https://github.com/airbytehq/airbyte/pull/8524) | Update connector fields title/description |
74+
| 0.1.14 | 2021-12-01 | [8380](https://github.com/airbytehq/airbyte/pull/8380) | Update `Events` stream to use `export/userEvents` endpoint |
75+
| 0.1.13 | 2021-11-22 | [8091](https://github.com/airbytehq/airbyte/pull/8091) | Adjust slice ranges for email streams |
76+
| 0.1.12 | 2021-11-09 | [7780](https://github.com/airbytehq/airbyte/pull/7780) | Split EmailSend stream into slices to fix premature connection close error |
77+
| 0.1.11 | 2021-11-03 | [7619](https://github.com/airbytehq/airbyte/pull/7619) | Bugfix type error while incrementally loading the `Templates` stream |
78+
| 0.1.10 | 2021-11-03 | [7591](https://github.com/airbytehq/airbyte/pull/7591) | Optimize export streams memory consumption for large requests |
79+
| 0.1.9 | 2021-10-06 | [5915](https://github.com/airbytehq/airbyte/pull/5915) | Enable campaign_metrics stream |
80+
| 0.1.8 | 2021-09-20 | [5915](https://github.com/airbytehq/airbyte/pull/5915) | Add new streams: campaign_metrics, events |
81+
| 0.1.7 | 2021-09-20 | [6242](https://github.com/airbytehq/airbyte/pull/6242) | Update schema for: campaigns, lists, templates, metadata |

0 commit comments

Comments
 (0)