Skip to content

Commit

Permalink
Add additional docs per connector checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
danieldiamond committed Dec 8, 2021
1 parent 0b7edb8 commit c37bd63
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 9 deletions.
1 change: 1 addition & 0 deletions airbyte-integrations/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
| PrestaShop | [![source-prestashop](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-prestashop%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-prestashop) |
| CockroachDb | [![source-cockroachdb](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-cockroachdb%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-cockroachdb) |
| Confluence | [![source-confluence](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-confluence%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-confluence) |
| Qualaroo | [![source-qualaroo](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-qualaroo%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-qualaroo) |
| Quickbooks | [![source-quickbooks-singer](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-quickbooks-singer%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-quickbooks-singer) |
| Recharge | [![source-recharge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-recharge%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-recharge) |
| Recurly | [![source-recurly](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-recurly%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-recurly) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@ tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
incremental:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
future_state_path: "integration_tests/abnormal_state.json"
cursor_paths:
actions: ["date"]
full_refresh:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
4 changes: 2 additions & 2 deletions airbyte-integrations/connectors/source-qualaroo/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
setup(
name="source_qualaroo",
description="Source implementation for Qualaroo.",
author="Airbyte",
author_email="[email protected]",
author="Daniel Diamond",
author_email="[email protected]",
packages=find_packages(),
install_requires=MAIN_REQUIREMENTS,
package_data={"": ["*.json", "schemas/*.json", "schemas/shared/*.json"]},
Expand Down
3 changes: 2 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* [On GCP (Compute Engine)](deploying-airbyte/on-gcp-compute-engine.md)
* [On Kubernetes (Beta)](deploying-airbyte/on-kubernetes.md)
* [On Oracle Cloud Infrastructure VM](deploying-airbyte/on-oci-vm.md)
* [On Digital Ocean Droplet](deploying-airbyte/on-digitalocean-droplet.md)
* [On Digital Ocean Droplet](deploying-airbyte/on-digitalocean-droplet.md)
* [Operator Guides](operator-guides/README.md)
* [Upgrading Airbyte](operator-guides/upgrading-airbyte.md)
* [Resetting Your Data](operator-guides/reset.md)
Expand Down Expand Up @@ -115,6 +115,7 @@
* [Postgres](integrations/sources/postgres.md)
* [PostHog](integrations/sources/posthog.md)
* [PrestaShop](integrations/sources/presta-shop.md)
* [Qualaroo](integrations/sources/qualaroo.md)
* [Quickbooks](integrations/sources/quickbooks.md)
* [Recharge](integrations/sources/recharge.md)
* [Recurly](integrations/sources/recurly.md)
Expand Down
1 change: 1 addition & 0 deletions docs/integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Airbyte uses a grading system for connectors to help users understand what to ex
| [Postgres](sources/postgres.md) | Certified |
| [PostHog](sources/posthog.md) | Beta |
| [PrestaShop](sources/presta-shop.md) | Beta |
| [Qualaroo](sources/qualaroo.md) | Beta |
| [Quickbooks](sources/quickbooks.md) | Beta |
| [Recharge](sources/recharge.md) | Beta |
| [Recurly](sources/recurly.md) | Beta |
Expand Down
47 changes: 47 additions & 0 deletions docs/integrations/sources/qualaroo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Qualaroo

## Overview

The Qualaroo source supports Full Refresh syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

This Source Connector is based on a [Airbyte CDK](https://docs.airbyte.io/connector-development/cdk-python).

### Output schema

Several output streams are available from this source:

* [Surveys](https://help.qualaroo.com/hc/en-us/articles/201969438-The-REST-Reporting-API) \(Full table\)
* [Responses](https://help.qualaroo.com/hc/en-us/articles/201969438-The-REST-Reporting-API) \(Full table\)

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

### Features

| Feature | Supported? |
| :--- | :--- |
| Full Refresh Sync | Yes |
| Incremental - Append Sync | NO |
| SSL connection | Yes |
| Namespaces | No |

### Performance considerations

The connector is **not** yet restricted by normal requests limitation. As a result, the Qualaroo connector might run into 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.

## Getting started

### Requirements

* Qualaroo API Key
* Qualaroo API Token

### Setup guide
<!-- markdown-link-check-disable-next-line -->
Please read [How to get your APIs Token and Key](https://help.qualaroo.com/hc/en-us/articles/201969438-The-REST-Reporting-API) or you can log in to Qualaroo and visit [Reporting API](https://app.qualaroo.com/account).

## Changelog

| Version | Date | Pull Request | Subject |
| :--- | :--- | :--- | :--- |
| 0.1.0 | 2021-08-18 | [8623](https://github.com/airbytehq/airbyte/pull/8623) | New source: Qualaroo |

0 comments on commit c37bd63

Please sign in to comment.