f488a04b69
## What Regenerates platform documentation version 2.0 from the latest Next (unreleased) version. This publishes all recent documentation updates that have been made to the Next version as the stable 2.0 release. Requested by Ian Alton (@ian-at-airbyte) via Slack thread: https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760747793195139?thread_ts=1760747793.195139 Link to Devin session: https://app.devin.ai/sessions/edbc303b017445de9731080a55c04586 ## How 1. Deleted the existing `version-2.0` directory from `platform_versioned_docs/` 2. Deleted the `version-2.0-sidebars.json` from `platform_versioned_sidebars/` 3. Temporarily removed `"2.0"` from `platform_versions.json` 4. Ran `pnpm docusaurus docs:version:platform 2.0` to regenerate version 2.0 from the current Next version 5. Verified the build succeeds locally ## Review guide 1. **New content**: `platform_versioned_docs/version-2.0/understanding-airbyte/cdc-best-practices.md` - Comprehensive new CDC configuration best practices guide. Review for technical accuracy. 2. **Sidebar changes**: `platform_versioned_sidebars/version-2.0-sidebars.json` - CDC content reorganized under "Sync Modes" section. Verify navigation makes sense. 3. **Terminology updates** throughout various files: - "Airbyte Open Source" → "Core" - "Cloud Teams" → "Cloud Pro" - "Self-Managed Community" → "Core" - Verify these align with actual product naming conventions 4. **Content improvements** in access management, API documentation, connector development, enterprise setup, and quickstart guides ## User Impact Users viewing the version 2.0 platform documentation will see the latest content updates, including: - New comprehensive CDC best practices documentation - Updated terminology reflecting current product names - Improved clarity and accuracy throughout documentation - Better organization of CDC-related content No negative side effects expected - this is a documentation-only update. ## Can this PR be safely reverted and rolled back? - [x] YES 💚 This is a documentation change only. Reverting would restore the previous version 2.0 documentation content. --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@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.