Skip to content

docs: Add comprehensive Sonar Embedded API documentation #67580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+3,313 −57
Open

docs: Add comprehensive Sonar Embedded API documentation #67580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c19651c
docs: Add comprehensive Sonar Embedded API documentation
teallarson Oct 8, 2025
ca11832
Fix markdown and vale linting issues in Sonar API documentation
teallarson Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .markdownlint.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@
},
"MD004": {
"style": "dash" // Enforce "dash" style for unordered list items (e.g., "- item")
}
},
"MD024": { "siblings_only": true } // Allow duplicate headings in different sections
}
6 changes: 5 additions & 1 deletion docs/ai-agents/embedded/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---

products: embedded

---

# Airbyte API
Expand All @@ -11,15 +13,17 @@ The Airbyte API allows you to build a fully integrated Airbyte Embedded Experien
Follow these steps to implement Airbyte Embedded with the API:

### 1. One-Time Setup (Your Organization)

First, configure the foundation for your embedded integration:

1. **[Create Connection Templates](./connection-templates.md)**: Define where your users' data will be stored (destination configuration)
2. **[Create Source Templates](./source-templates.md)**: Choose which data connectors your users can access

### 2. Per-User Integration (Runtime)

For each user who wants to connect their data:

3. **[Generate User Tokens & Configure Sources](./configuring-sources.md)**: Authenticate users and collect their source credentials
1. **[Generate User Tokens & Configure Sources](./configuring-sources.md)**: Authenticate users and collect their source credentials

This approach separates one-time organizational setup from per-user operations, making your integration more scalable.

Expand Down
Loading
Loading