From 9483b7cb0229d94e2377331cf767d43bc3562851 Mon Sep 17 00:00:00 2001 From: Natik Gadzhi Date: Wed, 21 Aug 2024 21:49:51 -0700 Subject: [PATCH] fix(connectors): fixed metadata and docs for new connectors from Builder (#44544) --- .../connectors/source-basecamp/metadata.yaml | 2 +- .../connectors/source-dbt/metadata.yaml | 2 +- .../source-leadfeeder/metadata.yaml | 2 +- .../connectors/source-pennylane/metadata.yaml | 2 +- docs/integrations/sources/basecamp.md | 23 +++++++-------- docs/integrations/sources/dbt.md | 22 +++++++------- docs/integrations/sources/leadfeeder.md | 14 ++++----- docs/integrations/sources/pennylane.md | 29 +++++++------------ 8 files changed, 42 insertions(+), 54 deletions(-) diff --git a/airbyte-integrations/connectors/source-basecamp/metadata.yaml b/airbyte-integrations/connectors/source-basecamp/metadata.yaml index 04d280669a2c..c9cbbbbc6f10 100644 --- a/airbyte-integrations/connectors/source-basecamp/metadata.yaml +++ b/airbyte-integrations/connectors/source-basecamp/metadata.yaml @@ -2,7 +2,7 @@ metadataSpecVersion: "1.0" data: allowedHosts: hosts: - - "*" + - "3.basecampapi.com" registryOverrides: oss: enabled: true diff --git a/airbyte-integrations/connectors/source-dbt/metadata.yaml b/airbyte-integrations/connectors/source-dbt/metadata.yaml index 2fc42f16bb5a..feca6824d03e 100644 --- a/airbyte-integrations/connectors/source-dbt/metadata.yaml +++ b/airbyte-integrations/connectors/source-dbt/metadata.yaml @@ -2,7 +2,7 @@ metadataSpecVersion: "1.0" data: allowedHosts: hosts: - - "*" + - cloud.getdbt.com registryOverrides: oss: enabled: true diff --git a/airbyte-integrations/connectors/source-leadfeeder/metadata.yaml b/airbyte-integrations/connectors/source-leadfeeder/metadata.yaml index 073f60e3fad2..4f8671b5e644 100644 --- a/airbyte-integrations/connectors/source-leadfeeder/metadata.yaml +++ b/airbyte-integrations/connectors/source-leadfeeder/metadata.yaml @@ -2,7 +2,7 @@ metadataSpecVersion: "1.0" data: allowedHosts: hosts: - - "*" + - api.leadfeeder.com registryOverrides: oss: enabled: true diff --git a/airbyte-integrations/connectors/source-pennylane/metadata.yaml b/airbyte-integrations/connectors/source-pennylane/metadata.yaml index b65544c090e0..cb843ae6d2ff 100644 --- a/airbyte-integrations/connectors/source-pennylane/metadata.yaml +++ b/airbyte-integrations/connectors/source-pennylane/metadata.yaml @@ -2,7 +2,7 @@ metadataSpecVersion: "1.0" data: allowedHosts: hosts: - - "*" + - app.pennylane.com registryOverrides: oss: enabled: true diff --git a/docs/integrations/sources/basecamp.md b/docs/integrations/sources/basecamp.md index 4bc4bea21fde..3dbc40649c3b 100644 --- a/docs/integrations/sources/basecamp.md +++ b/docs/integrations/sources/basecamp.md @@ -4,24 +4,23 @@ | Input | Type | Description | Default Value | |-------|------|-------------|---------------| -| `account_id` | `number` | Account ID. | | +| `account_id` | `number` | Your Basecamp Account ID. | | | `start_date` | `string` | Start date — used in incremental syncs. No records before that start date will be synced. | | -| `client_id` | `string` | Client ID. | | +| `client_id` | `string` | OAuth app Client ID. Go to [37Signals Launchpad](https://launchpad.37signals.com/integrations) to make a new OAuth app. | | | `client_secret` | `string` | Client secret. | | | `client_refresh_token_2` | `string` | Refresh token. | | +To obtain a refresh token, you'd need to register an [oauth application](https://launchpad.37signals.com/integrations) and then go through the OAuth flow. [`Basecampy`](https://github.com/phistrom/basecampy3) provides a CLI tool to do just that. + ## Streams + | Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental | |-------------|-------------|------------|---------------------|----------------------| -| projects | id | DefaultPaginator | ✅ | ❌ | - -| schedules | id | DefaultPaginator | ✅ | ❌ | - -| schedule_entries | id | DefaultPaginator | ✅ | ❌ | - -| todos | id | DefaultPaginator | ✅ | ✅ | - -| messages | id | DefaultPaginator | ✅ | ✅ | +| `projects` | `id` | DefaultPaginator | ✅ | ❌ | +| `schedules` | `id` | DefaultPaginator | ✅ | ❌ | +| `schedule_entries` | `id` | DefaultPaginator | ✅ | ❌ | +| `todos` | `id` | DefaultPaginator | ✅ | ✅ | +| `messages` | `id` | DefaultPaginator | ✅ | ✅ | ## Changelog @@ -33,4 +32,4 @@ |------------------|------------|----------------| | 0.0.1 | 2024-08-12 | Initial release by natikgadzhi via Connector Builder| - \ No newline at end of file + diff --git a/docs/integrations/sources/dbt.md b/docs/integrations/sources/dbt.md index ce1ea3234d75..dab6a6901294 100644 --- a/docs/integrations/sources/dbt.md +++ b/docs/integrations/sources/dbt.md @@ -1,24 +1,22 @@ # DBT +DBT Source Connector provides streams with your DBT projects, repositories, users, environments, and runs from DBT Cloud. + ## Configuration | Input | Type | Description | Default Value | |-------|------|-------------|---------------| -| `api_key_2` | `string` | Token. | | -| `account_id` | `string` | account_id. | | +| `api_key_2` | `string` | DBT API token. | | +| `account_id` | `string` | Your DBT account ID. | | ## Streams | Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental | |-------------|-------------|------------|---------------------|----------------------| -| runs | id | DefaultPaginator | ✅ | ❌ | - -| projects | id | DefaultPaginator | ✅ | ❌ | - -| repositories | id | DefaultPaginator | ✅ | ❌ | - -| users | id | DefaultPaginator | ✅ | ❌ | - -| environments | id | DefaultPaginator | ✅ | ❌ | +| `runs` | `id` | DefaultPaginator | ✅ | ❌ | +| `projects` | `id` | DefaultPaginator | ✅ | ❌ | +| `repositories` | `id` | DefaultPaginator | ✅ | ❌ | +| `users` | `id` | DefaultPaginator | ✅ | ❌ | +| `environments` | `id` | DefaultPaginator | ✅ | ❌ | ## Changelog @@ -30,4 +28,4 @@ |------------------|------------|----------------| | 0.0.1 | 2024-08-22 | Initial release by natikgadzhi via Connector Builder| - \ No newline at end of file + diff --git a/docs/integrations/sources/leadfeeder.md b/docs/integrations/sources/leadfeeder.md index 09e5f43ac698..8f6145630118 100644 --- a/docs/integrations/sources/leadfeeder.md +++ b/docs/integrations/sources/leadfeeder.md @@ -4,17 +4,15 @@ | Input | Type | Description | Default Value | |-------|------|-------------|---------------| -| `api_token` | `string` | Api Token. | | -| `start_date` | `string` | Start date. | | +| `api_token` | `string` | Leadfeeder API token. | | +| `start_date` | `string` | Start date for incremental syncs. Records that were updated before that date will not be synced. | | ## Streams | Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental | |-------------|-------------|------------|---------------------|----------------------| -| accounts | id | No pagination | ✅ | ❌ | - -| leads | id | DefaultPaginator | ✅ | ✅ | - -| visits | id | DefaultPaginator | ✅ | ✅ | +| `accounts` | `id` | No pagination | ✅ | ❌ | +| `leads` | `id` | DefaultPaginator | ✅ | ✅ | +| `visits` | `id` | DefaultPaginator | ✅ | ✅ | ## Changelog @@ -26,4 +24,4 @@ |------------------|------------|----------------| | 0.0.1 | 2024-08-21 | Initial release by natikgadzhi via Connector Builder| - \ No newline at end of file + diff --git a/docs/integrations/sources/pennylane.md b/docs/integrations/sources/pennylane.md index 23e245aededb..b858a8644309 100644 --- a/docs/integrations/sources/pennylane.md +++ b/docs/integrations/sources/pennylane.md @@ -4,27 +4,20 @@ | Input | Type | Description | Default Value | |-------|------|-------------|---------------| -| `start_time` | `string` | Start time. | | -| `api_key` | `string` | API Key. | | +| `start_time` | `string` | Start time, used for incremental syncs. No records created before that date will be synced. | | +| `api_key` | `string` | Pennylane API key. | | ## Streams | Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental | |-------------|-------------|------------|---------------------|----------------------| -| supplier_invoices | id | DefaultPaginator | ✅ | ✅ | - -| suppliers | source_id | DefaultPaginator | ✅ | ✅ | - -| plan_items | number | DefaultPaginator | ✅ | ❌ | - -| customers | source_id | DefaultPaginator | ✅ | ✅ | - -| customer_invoices | id | DefaultPaginator | ✅ | ✅ | - -| products | source_id | DefaultPaginator | ✅ | ✅ | - -| category_groups | id | DefaultPaginator | ✅ | ✅ | - -| categories | source_id | DefaultPaginator | ✅ | ✅ | +| `supplier_invoices` | `id` | DefaultPaginator | ✅ | ✅ | +| `suppliers` | `source_id` | DefaultPaginator | ✅ | ✅ | +| `plan_items` | `number` | DefaultPaginator | ✅ | ❌ | +| `customers` | `source_id` | DefaultPaginator | ✅ | ✅ | +| `customer_invoices` | `id` | DefaultPaginator | ✅ | ✅ | +| `products` | `source_id` | DefaultPaginator | ✅ | ✅ | +| `category_groups` | `id` | DefaultPaginator | ✅ | ✅ | +| `categories` | `source_id` | DefaultPaginator | ✅ | ✅ | ## Changelog @@ -36,4 +29,4 @@ |------------------|------------|----------------| | 0.0.1 | 2024-08-21 | Initial release by natikgadzhi via Connector Builder| - \ No newline at end of file +