docs: Enhance Sonar API documentation with core concepts guides #67593
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,7 @@ products: embedded | |||||||
|
|
||||||||
| The Airbyte API allows you to build a fully integrated Airbyte Embedded Experience. | ||||||||
|
|
||||||||
| ## Quick Start | ||||||||
|
|
||||||||
| Follow these steps to implement Airbyte Embedded with the API: | ||||||||
|
|
||||||||
|
|
@@ -23,4 +23,48 @@ For each user who wants to connect their data: | |||||||
|
|
||||||||
| This approach separates one-time organizational setup from per-user operations, making your integration more scalable. | ||||||||
|
|
||||||||
| ## Core Concepts | ||||||||
|
|
||||||||
| ### [Authentication](./authentication.md) | ||||||||
| Understand the different token types and how to securely authenticate your API calls: | ||||||||
|
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - **Access Tokens**: Organization-level administrative access | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - **Scoped Tokens**: User-level limited access for individual workspaces | ||||||||
| - **Widget Tokens**: Specialized tokens for the Embedded Widget | ||||||||
| - Security best practices and implementation examples | ||||||||
|
|
||||||||
| ### [Workspace Management](./workspace-management.md) | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 |
||||||||
| Learn how Airbyte Embedded creates isolated environments for each customer: | ||||||||
|
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - Multi-tenant architecture and data isolation | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - Automatic workspace creation | ||||||||
| - External ID best practices | ||||||||
| - Template tag filtering for workspace-specific configurations | ||||||||
|
|
||||||||
| ### [Schema Discovery](./schema-discovery.md) | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 |
||||||||
| Programmatically explore your customers' data structures: | ||||||||
|
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - Discover available streams (tables/collections) | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - Query field schemas and data types | ||||||||
| - Understand primary keys and relationships | ||||||||
| - Build dynamic UIs based on available data | ||||||||
|
|
||||||||
| ## API Guides | ||||||||
|
|
||||||||
| ### Setup & Configuration | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 |
||||||||
| - [Connection Templates](./connection-templates.md) - Configure destinations for your users | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - [Source Templates](./source-templates.md) - Define available data connectors | ||||||||
| - [Configuring Sources](./configuring-sources.md) - Collect user credentials and create sources | ||||||||
|
|
||||||||
| ### Advanced Topics | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 |
||||||||
| - [Schema Discovery](./schema-discovery.md) - Explore data structures programmatically | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| - [Workspace Management](./workspace-management.md) - Manage customer isolation | ||||||||
| - [Authentication](./authentication.md) - Secure token management | ||||||||
|
|
||||||||
| ## API Reference | ||||||||
|
|
||||||||
| The complete API reference with all endpoints, request/response schemas, and interactive testing is available at [api.airbyte.ai/api/v1/docs](https://api.airbyte.ai/api/v1/docs). | ||||||||
|
|
||||||||
| ## Need Help? | ||||||||
|
|
||||||||
| - **Documentation**: Browse the guides above for detailed implementation instructions | ||||||||
| - **API Reference**: [api.airbyte.ai/api/v1/docs](https://api.airbyte.ai/api/v1/docs) | ||||||||
| - **Support**: Contact [[email protected]](mailto:[email protected]) for assistance | ||||||||
| - **Sample App**: See a complete implementation in our [embedded demo app](https://github.com/airbytehq/embedded-demoapp) | ||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Authentication"]