b50994c6f3
## Overview This PR addresses critical documentation drift between the Sonar implementation and the Airbyte documentation repository. Based on a comprehensive drift analysis performed on 2025-10-08, this update adds missing API documentation for HIGH PRIORITY features that are fully implemented in Sonar but completely undocumented. Reference: docs-drift-analysis-2025-10-08.md (in sonar repo) ## Changes Summary ### New Documentation Files (3) 1. **workspaces.md** - Workspace Management API - List workspaces with cursor-based pagination - Get, update, and delete workspaces - Workspace statistics and sync operations - Complete pagination guide and filtering examples 2. **authentication.md** - Complete Authentication Guide - All three token types (Operator Bearer, Scoped, Widget) - Region selection (US/EU) - Template filtering via tags during token generation - Token lifecycle management and security best practices - 20+ code examples 3. **tags.md** - Template Tag Management - Tag CRUD operations - Tag selection modes (ANY vs ALL) - Tagging source and connection templates - Tier-based access control examples ### Updated Documentation Files (3) 4. **source-templates.md** - Enhanced with stream management, PATCH endpoint, tag operations, source definition catalogs 5. **connection-templates.md** - Added sync_on_create, non_breaking_changes_preference, cron validation, PATCH endpoint, tag operations 6. **configuring-sources.md** - Added region selection, stream management, JMESPath querying, JSON Patch operations ## Impact - 25+ previously undocumented API endpoints now documented - ~2,500 lines of documentation added - 100+ code examples - 12 HIGH PRIORITY documentation gaps addressed ## Validation All documentation validated against: - Sonar codebase at commit 350a75fe73 - FastAPI route definitions - Pydantic schemas - Existing documentation style ## Breaking Changes None - Documentation only --------- Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
19 lines
1.2 KiB
JSON
19 lines
1.2 KiB
JSON
{
|
|
//
|
|
// Configuration file for MarkDownLint. More information: https://docs.airbyte.com/contributing-to-airbyte/writing-docs#lint-with-markdownlint
|
|
//
|
|
"MD007": false, // Disable the "unordered-list-indentation" rule (allows unordered list items to be indented by any number of spaces)
|
|
"MD013": false, // Disable the "line-length" rule (allows long lines without warnings)
|
|
"MD033": false, // Disable the "no-inline-html" rule (allows inline HTML in Markdown)
|
|
"MD010": false, // Disable the "no-hard-tabs" rule (allows hard tabs instead of spaces)
|
|
"MD041": false, // Disable the "first-line-heading/first-line-h1" rule (allows files without a top-level heading as the first line)
|
|
"MD034": false, // Disable the rule that suggests using angle brackets instead of bare URLs. Angle brackets break the Docusaurus build.
|
|
"MD046": {
|
|
"style": "fenced" // Enforce fenced code blocks (e.g. ` or ```) and don't permit code sample indentation without fences
|
|
},
|
|
"MD004": {
|
|
"style": "dash" // Enforce "dash" style for unordered list items (e.g., "- item")
|
|
},
|
|
"MD024": { "siblings_only": true } // Allow duplicate headings in different sections
|
|
}
|