Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
@rileybrook
rileybrook committed Mar 3, 2023
1 parent b8ef218 commit 935577e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api-documentation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Airbyte has two sets of APIs which are intended for different uses. The table be

| | **Airbyte API** | **Configuration API** |
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **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. |
| **Description** | Airbyte API is a reliable, easy-to-use interface for programmatically controlling the Airbyte platform. With full support from 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. |
| **Status** | Currently in Closed Beta. <br /><br /> Full support from the Airbyte team. <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 935577e

Please sign in to comment.