4f97ee2dab
## What <!-- * Describe what the change is solving. Link all GitHub issues related to this change. --> This pull request updates plan names across most of the Documentation so they're consistent with our current plan names. ## How <!-- * Describe how code changes achieve the solution. --> My original plan was to convert free text to MDX variables so we only had to make future updates to names in one place. While broadly successful, there were numerous edge cases that made rolling this out almost impossible. There were too many ways and places you couldn't use variables due to a variety of limitations in Docusaurus and Airbyte's internal MarkDown processor. Explaining how to properly use them made me realize how prohibitively insufficient this was. In the end, I opted to return to using free text for plan names. Scope is now broadly reduced. This PR: - Converts remaining instances of old plan names to new plan names. In most cases, I replaced old plan names with new plan names directly. In some cases, sentences were rewritten to make a bit more sense or be more maintainable in the future. - Removes previously added preprocessor variables from Docusaurus configuration. - Update Vale styles or various artifacts of content based on linter findings. ## Review guide <!-- 1. `x.py` 2. `y.py` --> Spot check updated pages to ensure plan names appear appropriately. It's probably not necessary to check every single instance in detail. For Platform docs, changes only apply to the Next/Cloud version. After merging, I'll regenerate 2.0 docs based on this. 1.8 and before won't be updated. ## User Impact <!-- * What is the end result perceived by the user? * If there are negative side effects, please list them. --> People can see correct plan names in docs content. ## Can this PR be safely reverted and rolled back? <!-- * If unsure, leave it blank. --> - [x] YES 💚 - [ ] NO ❌ --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1.5 KiB
products
| products |
|---|
| all |
API documentation
The Airbyte API provides a way for developers to programmatically interact with Airbyte. It is available for all Airbyte plans.
Our API is a reliable, easy-to-use interface for programmatically controlling the Airbyte platform. It can be extended to:
- Enable users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow)
- Enable Airbyte Embedded
Configuring API Access
View our documentation here to learn how to start using the Airbyte API.
Using the Airbyte API
Navigate to our full API documentation to learn how to retrieve your access token, make API requests, and manage resources like sources, destinations, and workspaces.
Our full API documentation is located here: reference.airbyte.com.
:::note
To access the API in the Core plan, use the /api/public/v1 path prefix. For example, retrieve list of workspaces with curl http://localhost:8000/api/public/v1/workspaces.
:::
Configuration API (Deprecated)
The configuration API is now deprecated and no longer supported. It is an internal API that is designed for communications between different Airbyte components rather than managing your Airbyte workspace.
Users utilize the Config API at their own risk. This API is utilized internally by the Airbyte Engineering team and may be modified in the future if the need arises.