Skip to content

Commit

Permalink
Update API doc table (again)
Browse files Browse the repository at this point in the history
  • Loading branch information
rileybrook committed Mar 3, 2023
1 parent d2fbd8c commit b8ef218
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Airbyte has two sets of APIs which are intended for different uses. The table below outlines their descriptions, use cases, availability and status.

| | **Configuration API** | **Airbyte API** |
| | **Airbyte API** | **Configuration API** |
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Description** | The Config API is an internal Airbyte API that is designed for communications between different Airbyte components. | Airbyte API is designed for ease-of-use, reliability and full support by Airbyte team. |
| **Use Cases** | Enables OSS users to configure their own Self-Hosted Airbyte deployment (internal state, etc) <br /><br /> Enables Airbyte team to configure Airbyte Cloud (internal state, etc) | Enables users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow) <br /><br /> Exists for Airbyte users to write applications against. <br /><br /> Enables [Powered by Airbyte](https://airbyte.com/embed-airbyte-connectors-with-api) (Headless version and UI version) |
| **Available to be used by** | OSS users | Cloud users now (and OSS users in June 2023) |
| **Status** | 🚨 WARNING 🚨 API is in Alpha state. Airbyte does NOT have active commitments to support it. OSS users can interact with the Config API, but at their own risk of future breaking changes. <br /><br /> This API is utilized internally by the Airbyte Engineering team and can be changed by Airbyte Engineering if their needs require it, which could potentially break any external applications that are using it. If breaking changes did occur, OSS users would need to update their code to catch up to any backwards incompatible changes in the API. | Closed Beta. See [Airbyte roadmap](https://app.harvestr.io/roadmap/view/pQU6gdCyc/airbyte-roadmap) for more details and to request early-access. |
| **Documentation** | [Available here](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html) | Available to Closed Beta participants.
| **Description** | Airbyte API is designed for ease-of-use, reliability and full support by the Airbyte team. | The Config API is an internal Airbyte API that is designed for communications between different Airbyte components. |
| **Use Cases** | Enables users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow) <br /><br /> Exists for Airbyte users to write applications against. <br /><br /> Enables [Powered by Airbyte](https://airbyte.com/embed-airbyte-connectors-with-api) | Enables OSS users to configure their own Self-Hosted Airbyte deployment (internal state, etc) <br /><br /><br /> Enables Airbyte Engineering team to configure Airbyte Cloud (internal state) |
| **Available for** | Cloud users currently <br /> (OSS users in June 2023) | OSS users |
| **Status** | Currently in Closed Beta. <br /><br /> Early-access can be requested through early-access@airbyte.io | 🚨 WARNING 🚨 <br /><br /> Airbyte does NOT have active commitments to support this API long-term. OSS users can utilize the Config API, but at their own risk. <br /><br /> This API is utilized internally by the Airbyte Engineering team and may be modified in the future if the need arises. <br /><br /> Modifications by the Airbyte Engineering team could create breaking changes and OSS users would need to update their code to catch up to any backwards incompatible changes in the API. |
| **Documentation** | Available to Closed Beta participants. | [Available here](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html)

0 comments on commit b8ef218

Please sign in to comment.