1
0
mirror of synced 2025-12-19 18:14:56 -05:00

feat: Add external documentation URLs to all destination connectors (Group A) (#69353)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
This commit is contained in:
Aaron ("AJ") Steers
2025-11-17 21:11:07 -08:00
committed by GitHub
parent b1bf6296a9
commit 16aaee0b9e
89 changed files with 1494 additions and 38 deletions

View File

@@ -0,0 +1,554 @@
# External Documentation URLs Guide
## Overview
This guide explains how to identify, scrape, and maintain `externalDocumentationUrls` in connector `metadata.yaml` files. These URLs point to official vendor documentation that helps users understand API changes, authentication requirements, rate limits, and other critical information.
### Purpose
External documentation URLs serve several key purposes:
- Surface vendor changelogs and release notes for tracking breaking changes
- Provide quick access to authentication and permissions documentation
- Link to rate limits and quota information
- Direct users to official API references and data model documentation
- Connect users with vendor status pages and developer communities
### Schema Location
The schema is defined in `airbyte-ci/connectors/metadata_service/lib/metadata_service/models/src/ConnectorMetadataDefinitionV0.yaml`.
The `externalDocumentationUrls` field is an optional array where each entry contains:
- `title` (required): Display title for the documentation link
- `url` (required): URL to the external documentation
- `type` (optional): Category of documentation (see taxonomy below)
- `requiresLogin` (optional, default: false): Whether the URL requires authentication to access
## Documentation Type Taxonomy
### api_release_history
**Description:** Changelogs, release notes, API version history, and out-of-cycle changes.
**Typical URL patterns:**
- `*/changelog*`
- `*/release-notes*`
- `*/api/versions*`
- `*/whats-new*`
**Examples:**
- Airtable: `https://airtable.com/developers/web/api/changelog`
- Google Ads: `https://developers.google.com/google-ads/api/docs/release-notes`
- Salesforce: `https://help.salesforce.com/s/articleView?id=release-notes.salesforce_release_notes.htm`
- Facebook Marketing: `https://developers.facebook.com/docs/marketing-api/marketing-api-changelog`
### api_reference
**Description:** API documentation, versioning docs, technical references, and API specifications.
**Typical URL patterns:**
- `*/api/reference*`
- `*/api/docs*`
- `*/developers/api*`
- `*/api-reference*`
**Examples:**
- GitLab: `https://docs.gitlab.com/ee/api/rest/`
- Chargebee: `https://apidocs.chargebee.com/docs/api/versioning`
- Azure Blob Storage: `https://learn.microsoft.com/en-us/rest/api/storageservices/`
- Pinecone: `https://docs.pinecone.io/reference/api/introduction`
### api_deprecations
**Description:** Deprecation notices, future breaking changes, and migration timelines.
**Typical URL patterns:**
- `*/deprecations*`
- `*/breaking-changes*`
- `*/sunset*`
- `*/migration*`
**Examples:**
- GitLab: `https://docs.gitlab.com/ee/api/rest/deprecations.html`
- Facebook Marketing: `https://developers.facebook.com/docs/marketing-api/out-of-cycle-changes/`
- Stripe: `https://stripe.com/docs/upgrades#api-versions`
### authentication_guide
**Description:** Official OAuth/API key setup, consent flows, and authentication methods.
**Typical URL patterns:**
- `*/oauth*`
- `*/authentication*`
- `*/auth*`
- `*/api-keys*`
- `*/credentials*`
**Examples:**
- Airtable: `https://airtable.com/developers/web/api/oauth-reference`
- Google Cloud: `https://cloud.google.com/iam/docs/service-accounts`
- Salesforce: `https://help.salesforce.com/s/articleView?id=sf.connected_app_create.htm`
- Snowflake: `https://docs.snowflake.com/en/user-guide/key-pair-auth`
### permissions_scopes
**Description:** Required roles, permissions, OAuth scopes, or database GRANTs.
**Typical URL patterns:**
- `*/permissions*`
- `*/scopes*`
- `*/roles*`
- `*/access-control*`
- `*/grants*`
**Examples:**
- BigQuery: `https://cloud.google.com/bigquery/docs/access-control`
- Salesforce: `https://help.salesforce.com/s/articleView?id=sf.connected_app_create_api_integration.htm`
- Google Ads: `https://developers.google.com/google-ads/api/docs/oauth/overview`
- Postgres: `https://www.postgresql.org/docs/current/sql-grant.html`
### rate_limits
**Description:** Rate limits, quotas, throttling behavior, and concurrency limits.
**Typical URL patterns:**
- `*/rate-limits*`
- `*/quotas*`
- `*/limits*`
- `*/throttling*`
**Examples:**
- BigQuery: `https://cloud.google.com/bigquery/quotas`
- GitHub: `https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting`
- Salesforce: `https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/`
- Stripe: `https://stripe.com/docs/rate-limits`
### status_page
**Description:** Vendor status/uptime pages for incident tracking.
**Typical URL patterns:**
- `status.*`
- `*/status*`
- `*/system-status*`
**Examples:**
- Snowflake: `https://status.snowflake.com/`
- Google Cloud: `https://status.cloud.google.com/`
- Salesforce: `https://status.salesforce.com/`
- GitHub: `https://www.githubstatus.com/`
### data_model_reference
**Description:** Object/field/endpoint reference for SaaS APIs (what tables/fields exist).
**Typical URL patterns:**
- `*/object-reference*`
- `*/data-model*`
- `*/schema*`
- `*/objects*`
**Examples:**
- Salesforce: `https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/`
- HubSpot: `https://developers.hubspot.com/docs/api/crm/understanding-the-crm`
- GitHub: `https://docs.github.com/en/rest/overview/resources-in-the-rest-api`
### sql_reference
**Description:** SQL dialect/reference docs for databases and warehouses.
**Typical URL patterns:**
- `*/sql-reference*`
- `*/sql/reference*`
- `*/language-reference*`
**Examples:**
- BigQuery: `https://cloud.google.com/bigquery/docs/reference/standard-sql`
- Snowflake: `https://docs.snowflake.com/en/sql-reference`
- Postgres: `https://www.postgresql.org/docs/current/sql.html`
- Redshift: `https://docs.aws.amazon.com/redshift/latest/dg/c_SQL_reference.html`
### migration_guide
**Description:** Vendor migration/breaking-change guides between versions.
**Typical URL patterns:**
- `*/migration*`
- `*/upgrade*`
- `*/version-migration*`
**Examples:**
- Stripe: `https://stripe.com/docs/upgrades`
- Elasticsearch: `https://www.elastic.co/guide/en/elasticsearch/reference/current/breaking-changes.html`
### developer_community
**Description:** Official forums/communities for vendor Q&A and technical discussions.
**Typical URL patterns:**
- `community.*`
- `*/community*`
- `*/forum*`
- `*/discussions*`
**Examples:**
- Airtable: `https://community.airtable.com/development-apis-11`
- Salesforce: `https://developer.salesforce.com/forums`
- Snowflake: `https://community.snowflake.com/`
### other
**Description:** Catch-all for documentation that doesn't fit other categories. Use sparingly.
**Note:** Since `type` is optional, prefer omitting the type field rather than using "other" when a link doesn't fit neatly into a category.
## How to Find Documentation URLs
### Preferred Sources (in order of priority)
1. **Official vendor documentation** (e.g., `docs.vendor.com`, `developers.vendor.com`)
2. **Official vendor blogs** (e.g., `blog.vendor.com`, `developers.vendor.com/blog`)
3. **Official community forums** (e.g., `community.vendor.com`)
### Search Query Templates
Use these search patterns to find appropriate documentation:
```
# Release notes / changelogs
site:<vendor-domain> "release notes"
site:<vendor-domain> "changelog"
site:<vendor-domain> "API changelog"
# API reference
site:<vendor-domain> "API reference"
site:<vendor-domain> "API documentation"
# Authentication
site:<vendor-domain> "OAuth"
site:<vendor-domain> "authentication"
site:<vendor-domain> "API key"
# Permissions
site:<vendor-domain> "permissions"
site:<vendor-domain> "scopes"
site:<vendor-domain> "access control"
# Rate limits
site:<vendor-domain> "rate limits"
site:<vendor-domain> "quotas"
site:<vendor-domain> "API limits"
# Status page
site:status.<vendor-domain>
"<vendor>" status page
# SQL reference (for databases/warehouses)
site:<vendor-domain> "SQL reference"
site:<vendor-domain> "language reference"
```
### URL Selection Heuristics
1. **Prefer canonical, version-agnostic URLs** that are updated over time rather than version-specific pages
- ✅ Good: `https://docs.vendor.com/api/changelog`
- ❌ Avoid: `https://docs.vendor.com/v2.3/api/changelog`
2. **Avoid locale-specific paths** when generic URLs exist
- ✅ Good: `https://docs.vendor.com/api/reference`
- ❌ Avoid: `https://docs.vendor.com/en-us/api/reference`
3. **Prefer stable root pages** over deep-linked anchors that may change
- ✅ Good: `https://docs.vendor.com/rate-limits`
- ⚠️ Use with caution: `https://docs.vendor.com/api#rate-limits-section`
4. **Always use official vendor domains** - never third-party mirrors or documentation aggregators
5. **Set `requiresLogin: true`** when the URL requires authentication to access
## Connector Family-Specific Guidance
### Data Warehouses (BigQuery, Snowflake, Redshift, Databricks)
**Priority types to include:**
- `sql_reference` (required) - SQL dialect documentation
- `authentication_guide` - Service account, key pair, or IAM auth
- `permissions_scopes` - Required roles and grants
- `api_release_history` - Release notes for API/driver changes
- `status_page` - Service status monitoring
- `rate_limits` - Query limits, concurrency limits (if applicable)
**Example (BigQuery):**
```yaml
externalDocumentationUrls:
- title: Release notes
url: https://cloud.google.com/bigquery/docs/release-notes
type: api_release_history
- title: Standard SQL reference
url: https://cloud.google.com/bigquery/docs/reference/standard-sql
type: sql_reference
- title: Service account authentication
url: https://cloud.google.com/iam/docs/service-accounts
type: authentication_guide
- title: Access control and permissions
url: https://cloud.google.com/bigquery/docs/access-control
type: permissions_scopes
- title: Quotas and limits
url: https://cloud.google.com/bigquery/quotas
type: rate_limits
- title: Google Cloud Status
url: https://status.cloud.google.com/
type: status_page
```
### Databases (Postgres, MySQL, MSSQL, MongoDB)
**Priority types to include:**
- `sql_reference` (for SQL databases) - SQL dialect documentation
- `authentication_guide` - Connection and authentication methods
- `permissions_scopes` - User permissions and grants
- `api_release_history` - Version release notes (if applicable)
**Example (Postgres):**
```yaml
externalDocumentationUrls:
- title: PostgreSQL documentation
url: https://www.postgresql.org/docs/current/
type: api_reference
- title: SQL reference
url: https://www.postgresql.org/docs/current/sql.html
type: sql_reference
- title: Authentication methods
url: https://www.postgresql.org/docs/current/auth-methods.html
type: authentication_guide
- title: GRANT permissions
url: https://www.postgresql.org/docs/current/sql-grant.html
type: permissions_scopes
```
### SaaS APIs (Salesforce, HubSpot, GitHub, Stripe)
**Priority types to include:**
- `api_release_history` (required) - Changelogs and release notes
- `api_reference` - API documentation
- `api_deprecations` - Deprecation schedules (if available)
- `authentication_guide` - OAuth or API key setup
- `permissions_scopes` - Required scopes or permissions
- `rate_limits` - API rate limits
- `data_model_reference` - Object/field reference
- `developer_community` - Developer forums
- `status_page` - Service status
**Example (Salesforce):**
```yaml
externalDocumentationUrls:
- title: API release notes
url: https://help.salesforce.com/s/articleView?id=release-notes.salesforce_release_notes.htm
type: api_release_history
- title: REST API reference
url: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/
type: api_reference
- title: Connected app OAuth
url: https://help.salesforce.com/s/articleView?id=sf.connected_app_create.htm
type: authentication_guide
- title: OAuth scopes
url: https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_tokens_scopes.htm
type: permissions_scopes
- title: API rate limits
url: https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/
type: rate_limits
- title: Object reference
url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/
type: data_model_reference
- title: Salesforce Status
url: https://status.salesforce.com/
type: status_page
```
### Vector Stores (Pinecone, Weaviate, Qdrant, Chroma)
**Priority types to include:**
- `api_reference` (required) - API documentation
- `rate_limits` - Request limits and quotas
- `authentication_guide` - API key or authentication setup
- `api_release_history` - Release notes (if available)
- `status_page` - Service status (if available)
- `migration_guide` - Version migration guides (if versions differ significantly)
**Example (Pinecone):**
```yaml
externalDocumentationUrls:
- title: API reference
url: https://docs.pinecone.io/reference/api/introduction
type: api_reference
- title: Authentication
url: https://docs.pinecone.io/guides/get-started/authentication
type: authentication_guide
- title: Rate limits
url: https://docs.pinecone.io/troubleshooting/rate-limits
type: rate_limits
- title: Release notes
url: https://docs.pinecone.io/release-notes
type: api_release_history
```
## Maintenance Guidelines
### Link Stability Checks
Periodically validate that external documentation URLs are still accessible:
1. **HTTP status validation** - Check that URLs return 200 or 3xx status codes
2. **Flag 4xx/5xx errors** - Document broken links for replacement
3. **Set `requiresLogin: true`** when appropriate to avoid false positives
**Simple validation script:**
```bash
# Check a single URL
curl -I -L -s -o /dev/null -w "%{http_code}" "https://docs.vendor.com/api/changelog"
# Expected: 200, 301, 302
# Action needed: 404, 403, 500
```
### Update Cadence
- **Quarterly sweep** - Review all external documentation URLs for broken links
- **On vendor announcements** - Update when vendors announce major documentation restructuring
- **On deprecation notices** - Add `api_deprecations` links when vendors announce breaking changes
### Replacement Rules
When updating broken or outdated links:
1. **Prefer same domain** - Look for the new location on the same vendor domain
2. **Check vendor consolidation** - Vendors may consolidate multiple doc sites into one
3. **Update to canonical** - If vendor provides a redirect, update to the final destination
4. **Document in PR** - Note why the link was changed in the PR description
### PR Review Practices
When reviewing PRs that add or modify external documentation URLs:
1. **Spot-check 2-3 links** per connector to verify they're accessible and relevant
2. **Verify type categorization** - Ensure the `type` field matches the content
3. **Check for duplicates** - Avoid adding the same URL twice with different titles
4. **Validate requiresLogin** - Confirm whether authentication is actually required
## YAML Template
Here's a canonical example showing multiple types:
```yaml
externalDocumentationUrls:
- title: Release notes
url: https://cloud.google.com/bigquery/docs/release-notes
type: api_release_history
- title: Standard SQL reference
url: https://cloud.google.com/bigquery/docs/reference/standard-sql
type: sql_reference
- title: Service account authentication
url: https://cloud.google.com/iam/docs/service-accounts
type: authentication_guide
- title: Access control and permissions
url: https://cloud.google.com/bigquery/docs/access-control
type: permissions_scopes
- title: Quotas and limits
url: https://cloud.google.com/bigquery/quotas
type: rate_limits
- title: Google Cloud Status
url: https://status.cloud.google.com/
type: status_page
requiresLogin: false
```
## Validation Checklist
Before submitting a PR with external documentation URLs:
- [ ] Schema validation passes (run `poetry run metadata_service validate <metadata.yaml> <doc.md>`)
- [ ] All URLs return HTTP 200 or 3xx status codes
- [ ] No paywalls or login requirements (unless `requiresLogin: true` is set)
- [ ] URLs are canonical and version-agnostic when possible
- [ ] Type categorization is accurate
- [ ] No duplicate URLs with different titles
- [ ] Official vendor domains only (no third-party mirrors)
- [ ] Titles are descriptive and consistent with vendor terminology
## Common Pitfalls to Avoid
1. **Don't over-categorize** - If a link doesn't fit neatly, omit the `type` field rather than forcing it
2. **Avoid version-specific URLs** - Prefer evergreen URLs that are updated over time
3. **Don't link to third-party docs** - Always use official vendor documentation
4. **Watch for locale redirects** - Some URLs may redirect based on browser locale
5. **Don't assume status pages exist** - Not all vendors have public status pages
6. **Avoid deep anchors** - Deep-linked sections may change; prefer stable root pages
7. **Don't duplicate content** - If a single page covers multiple topics, link it once with the most specific type
## Examples by Connector Type
### Example: Snowflake (Data Warehouse)
```yaml
externalDocumentationUrls:
- title: Release notes
url: https://docs.snowflake.com/en/release-notes
type: api_release_history
- title: SQL reference
url: https://docs.snowflake.com/en/sql-reference
type: sql_reference
- title: Key pair authentication
url: https://docs.snowflake.com/en/user-guide/key-pair-auth
type: authentication_guide
- title: Access control
url: https://docs.snowflake.com/en/user-guide/security-access-control
type: permissions_scopes
- title: Snowflake Status
url: https://status.snowflake.com/
type: status_page
```
### Example: Stripe (SaaS API)
```yaml
externalDocumentationUrls:
- title: API changelog
url: https://stripe.com/docs/upgrades#api-changelog
type: api_release_history
- title: API reference
url: https://stripe.com/docs/api
type: api_reference
- title: API versioning and upgrades
url: https://stripe.com/docs/upgrades
type: migration_guide
- title: Authentication
url: https://stripe.com/docs/keys
type: authentication_guide
- title: Rate limits
url: https://stripe.com/docs/rate-limits
type: rate_limits
- title: Stripe Status
url: https://status.stripe.com/
type: status_page
```
### Example: Postgres (Database)
```yaml
externalDocumentationUrls:
- title: PostgreSQL documentation
url: https://www.postgresql.org/docs/current/
type: api_reference
- title: SQL commands
url: https://www.postgresql.org/docs/current/sql-commands.html
type: sql_reference
- title: Client authentication
url: https://www.postgresql.org/docs/current/client-authentication.html
type: authentication_guide
- title: Database roles and privileges
url: https://www.postgresql.org/docs/current/user-manag.html
type: permissions_scopes
```
## Regenerating Schema After Changes
If you modify the schema enum in `ConnectorMetadataDefinitionV0.yaml`, regenerate the generated models:
```bash
cd airbyte-ci/connectors/metadata_service/lib
poetry install
poetry run poe generate-models
```
This will update:
- `metadata_service/models/generated/ConnectorMetadataDefinitionV0.json`
- `metadata_service/models/generated/ConnectorMetadataDefinitionV0.py`
## Additional Resources
- [Connector Metadata Schema](../lib/metadata_service/models/src/ConnectorMetadataDefinitionV0.yaml)
- [Metadata Service README](../lib/README.md)
- [Connector Development Guide](https://docs.airbyte.com/connector-development/)

View File

@@ -199,12 +199,20 @@
},
"type": {
"type": "string",
"description": "Category of documentation (api_release_history, api_reference, api_deprecations, or other)",
"description": "Category of documentation",
"enum": [
"api_release_history",
"api_reference",
"api_deprecations",
"other"
"api_reference",
"api_release_history",
"authentication_guide",
"data_model_reference",
"developer_community",
"migration_guide",
"other",
"permissions_scopes",
"rate_limits",
"sql_reference",
"status_page"
]
},
"requiresLogin": {

View File

@@ -18,11 +18,21 @@ class ExternalDocumentationUrl(BaseModel):
title: str = Field(..., description="Display title for the documentation link")
url: AnyUrl = Field(..., description="URL to the external documentation")
type: Optional[
Literal["api_release_history", "api_reference", "api_deprecations", "other"]
] = Field(
None,
description="Category of documentation (api_release_history, api_reference, api_deprecations, or other)",
)
Literal[
"api_deprecations",
"api_reference",
"api_release_history",
"authentication_guide",
"data_model_reference",
"developer_community",
"migration_guide",
"other",
"permissions_scopes",
"rate_limits",
"sql_reference",
"status_page",
]
] = Field(None, description="Category of documentation")
requiresLogin: Optional[bool] = Field(
False, description="Whether the URL requires authentication to access"
)

View File

@@ -77,12 +77,20 @@ properties:
description: "URL to the external documentation"
type:
type: string
description: "Category of documentation (api_release_history, api_reference, api_deprecations, or other)"
description: "Category of documentation"
enum:
- api_release_history
- api_reference
- api_deprecations
- api_reference
- api_release_history
- authentication_guide
- data_model_reference
- developer_community
- migration_guide
- other
- permissions_scopes
- rate_limits
- sql_reference
- status_page
requiresLogin:
type: boolean
description: "Whether the URL requires authentication to access"

View File

@@ -36,4 +36,20 @@ data:
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
externalDocumentationUrls:
- title: Amazon SQS documentation
url: https://docs.aws.amazon.com/sqs/
type: api_reference
- title: IAM authentication
url: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
type: authentication_guide
- title: IAM policies
url: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html
type: permissions_scopes
- title: Quotas and limits
url: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html
type: rate_limits
- title: AWS Service Health Dashboard
url: https://health.aws.amazon.com/health/status
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -44,4 +44,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: DataStax Astra documentation
url: https://docs.datastax.com/en/astra-serverless/docs/
type: api_reference
- title: CQL reference
url: https://docs.datastax.com/en/cql-oss/3.x/cql/cql_reference/cqlReferenceTOC.html
type: sql_reference
- title: Authentication
url: https://docs.datastax.com/en/astra-serverless/docs/manage/org/manage-tokens.html
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: AWS Lake Formation documentation
url: https://docs.aws.amazon.com/lake-formation/
type: api_reference
- title: IAM authentication
url: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
type: authentication_guide
- title: Permissions
url: https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -31,9 +31,13 @@ data:
name: Azure Blob Storage
connectorIPCOptions:
dataChannel:
version: "0.0.2"
supportedSerialization: ["JSONL", "PROTOBUF"]
supportedTransport: ["SOCKET", "STDIO"]
version: 0.0.2
supportedSerialization:
- JSONL
- PROTOBUF
supportedTransport:
- SOCKET
- STDIO
registryOverrides:
cloud:
enabled: true
@@ -72,4 +76,20 @@ data:
- language:java
supportsFileTransfer: true
supportsRefreshes: true
externalDocumentationUrls:
- title: Azure Blob Storage documentation
url: https://learn.microsoft.com/en-us/azure/storage/blobs/
type: api_reference
- title: Authorize access
url: https://learn.microsoft.com/en-us/azure/storage/common/authorize-data-access
type: authentication_guide
- title: Access control
url: https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-access-control
type: permissions_scopes
- title: Scalability and performance
url: https://learn.microsoft.com/en-us/azure/storage/blobs/scalability-targets
type: rate_limits
- title: Azure Status
url: https://status.azure.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -32,4 +32,14 @@ data:
sl: 100
ql: 300
supportLevel: archived
externalDocumentationUrls:
- title: BigQuery documentation
url: https://cloud.google.com/bigquery/docs
type: api_reference
- title: Standard SQL reference
url: https://cloud.google.com/bigquery/docs/reference/standard-sql
type: sql_reference
- title: Service account authentication
url: https://cloud.google.com/iam/docs/service-accounts
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -17,9 +17,13 @@ data:
baseImage: docker.io/airbyte/java-connector-base:2.0.1@sha256:ec89bd1a89e825514dd2fc8730ba299a3ae1544580a078df0e35c5202c2085b3
connectorIPCOptions:
dataChannel:
version: "0.0.2"
supportedSerialization: ["JSONL", "PROTOBUF"]
supportedTransport: ["SOCKET", "STDIO"]
version: 0.0.2
supportedSerialization:
- JSONL
- PROTOBUF
supportedTransport:
- SOCKET
- STDIO
registryOverrides:
cloud:
enabled: true
@@ -80,4 +84,23 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Release notes
url: https://cloud.google.com/bigquery/docs/release-notes
type: api_release_history
- title: Standard SQL reference
url: https://cloud.google.com/bigquery/docs/reference/standard-sql
type: sql_reference
- title: Service account authentication
url: https://cloud.google.com/iam/docs/service-accounts
type: authentication_guide
- title: Access control and permissions
url: https://cloud.google.com/bigquery/docs/access-control
type: permissions_scopes
- title: Quotas and limits
url: https://cloud.google.com/bigquery/quotas
type: rate_limits
- title: Google Cloud Status
url: https://status.cloud.google.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,14 @@ data:
sl: 100
ql: 100
supportLevel: community
externalDocumentationUrls:
- title: Cassandra documentation
url: https://cassandra.apache.org/doc/latest/
type: api_reference
- title: CQL reference
url: https://cassandra.apache.org/doc/latest/cassandra/cql/
type: sql_reference
- title: Authentication
url: https://cassandra.apache.org/doc/latest/cassandra/configuration/cass_yaml_file.html#authenticator
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -25,4 +25,11 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: Chroma documentation
url: https://docs.trychroma.com/
type: api_reference
- title: Authentication
url: https://docs.trychroma.com/deployment/auth
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -12,9 +12,13 @@ data:
baseImage: docker.io/airbyte/java-connector-base:2.0.1@sha256:ec89bd1a89e825514dd2fc8730ba299a3ae1544580a078df0e35c5202c2085b3
connectorIPCOptions:
dataChannel:
version: "0.0.2"
supportedSerialization: ["JSONL", "PROTOBUF"]
supportedTransport: ["SOCKET", "STDIO"]
version: 0.0.2
supportedSerialization:
- JSONL
- PROTOBUF
supportedTransport:
- SOCKET
- STDIO
registryOverrides:
cloud:
enabled: true
@@ -46,4 +50,14 @@ data:
type: GSM
alias: airbyte-connector-testing-secret-store
supportsRefreshes: true
externalDocumentationUrls:
- title: ClickHouse documentation
url: https://clickhouse.com/docs
type: api_reference
- title: SQL reference
url: https://clickhouse.com/docs/en/sql-reference
type: sql_reference
- title: User authentication
url: https://clickhouse.com/docs/en/operations/access-rights
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,14 @@ data:
- suite: integrationTests
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: Convex documentation
url: https://docs.convex.dev/
type: api_reference
- title: Authentication
url: https://docs.convex.dev/auth
type: authentication_guide
- title: Convex Status
url: https://status.convex.dev/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -23,4 +23,11 @@ data:
tags:
- language:python
- cdk:python
externalDocumentationUrls:
- title: Couchbase documentation
url: https://docs.couchbase.com/
type: api_reference
- title: Authentication
url: https://docs.couchbase.com/server/current/learn/security/authentication.html
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,8 @@ data:
supportLevel: community
tags:
- language:java
externalDocumentationUrls:
- title: CSV specification
url: https://datatracker.ietf.org/doc/html/rfc4180
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,11 @@ data:
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: Cumul.io documentation
url: https://developer.cumul.io/
type: api_reference
- title: Authentication
url: https://developer.cumul.io/#authentication
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -1,7 +1,7 @@
data:
allowedHosts:
hosts:
- "track.customer.io"
- track.customer.io
registryOverrides:
cloud:
enabled: true
@@ -29,4 +29,17 @@ data:
supportLevel: certified
supportsDataActivation: true
supportsRefreshes: true # needed for the CDK to work as it relies on the generation/sync ids to work
externalDocumentationUrls:
- title: Customer.io API documentation
url: https://customer.io/docs/api/
type: api_reference
- title: Authentication
url: https://customer.io/docs/api/app/#tag/Authentication
type: authentication_guide
- title: Rate limits
url: https://customer.io/docs/api/app/#tag/Rate-Limits
type: rate_limits
- title: Customer.io Status
url: https://status.customer.io/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -36,4 +36,11 @@ data:
# alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: Databend documentation
url: https://databend.rs/doc/
type: api_reference
- title: SQL reference
url: https://databend.rs/doc/sql-reference
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -74,4 +74,20 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Release notes
url: https://docs.databricks.com/release-notes/index.html
type: api_release_history
- title: SQL reference
url: https://docs.databricks.com/sql/language-manual/index.html
type: sql_reference
- title: Authentication
url: https://docs.databricks.com/dev-tools/auth.html
type: authentication_guide
- title: Access control
url: https://docs.databricks.com/security/access-control/index.html
type: permissions_scopes
- title: Databricks Status
url: https://status.databricks.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -39,3 +39,10 @@ data:
sl: 100
ql: 100
supportsFileTransfer: true
externalDocumentationUrls:
- title: Deepset Cloud documentation
url: https://docs.cloud.deepset.ai/
type: api_reference
- title: Authentication
url: https://docs.cloud.deepset.ai/docs/authentication
type: authentication_guide

View File

@@ -21,4 +21,11 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Apache Doris documentation
url: https://doris.apache.org/docs/dev/
type: api_reference
- title: SQL reference
url: https://doris.apache.org/docs/dev/sql-manual/sql-reference/
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -68,4 +68,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: DuckDB documentation
url: https://duckdb.org/docs/
type: api_reference
- title: SQL reference
url: https://duckdb.org/docs/sql/introduction
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,20 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: DynamoDB documentation
url: https://docs.aws.amazon.com/dynamodb/
type: api_reference
- title: IAM authentication
url: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
type: authentication_guide
- title: IAM policies
url: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/iam-policy-structure.html
type: permissions_scopes
- title: Service quotas
url: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ServiceQuotas.html
type: rate_limits
- title: AWS Service Health Dashboard
url: https://health.aws.amazon.com/health/status
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -22,4 +22,20 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: Elasticsearch documentation
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
type: api_reference
- title: Release notes
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/es-release-notes.html
type: api_release_history
- title: Authentication
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/setting-up-authentication.html
type: authentication_guide
- title: Security privileges
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html
type: permissions_scopes
- title: Elastic Cloud Status
url: https://status.elastic.co/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,20 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: Elasticsearch documentation
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
type: api_reference
- title: Release notes
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/es-release-notes.html
type: api_release_history
- title: Authentication
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/setting-up-authentication.html
type: authentication_guide
- title: Security privileges
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html
type: permissions_scopes
- title: Elastic Cloud Status
url: https://status.elastic.co/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -20,4 +20,11 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Exasol documentation
url: https://docs.exasol.com/
type: api_reference
- title: SQL reference
url: https://docs.exasol.com/db/latest/sql_references/sqlreferencesoverview.htm
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -34,4 +34,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Firebolt documentation
url: https://docs.firebolt.io/
type: api_reference
- title: SQL reference
url: https://docs.firebolt.io/sql_reference/
type: sql_reference
- title: Authentication
url: https://docs.firebolt.io/godocs/Overview/managing-your-organization/service-accounts.html
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,20 @@ data:
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: Firestore documentation
url: https://firebase.google.com/docs/firestore
type: api_reference
- title: Authentication
url: https://firebase.google.com/docs/firestore/security/get-started
type: authentication_guide
- title: Security rules
url: https://firebase.google.com/docs/firestore/security/rules-structure
type: permissions_scopes
- title: Quotas and limits
url: https://firebase.google.com/docs/firestore/quotas
type: rate_limits
- title: Firebase Status
url: https://status.firebase.google.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,14 @@ data:
supportsRefreshes: true
tags:
- language:java
externalDocumentationUrls:
- title: Cloud Storage documentation
url: https://cloud.google.com/storage/docs
type: api_reference
- title: Service account authentication
url: https://cloud.google.com/iam/docs/service-accounts
type: authentication_guide
- title: Access control
url: https://cloud.google.com/storage/docs/access-control
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -43,4 +43,20 @@ data:
supportLevel: community
tags:
- language:java
externalDocumentationUrls:
- title: Cloud Storage documentation
url: https://cloud.google.com/storage/docs
type: api_reference
- title: Service account authentication
url: https://cloud.google.com/iam/docs/service-accounts
type: authentication_guide
- title: Access control
url: https://cloud.google.com/storage/docs/access-control
type: permissions_scopes
- title: Quotas and limits
url: https://cloud.google.com/storage/quotas
type: rate_limits
- title: Google Cloud Status
url: https://status.cloud.google.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -44,4 +44,8 @@ data:
type: GSM
alias: airbyte-connector-testing-secret-store
releaseStage: alpha
externalDocumentationUrls:
- title: Glassflow documentation
url: https://docs.glassflow.dev/
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -38,4 +38,17 @@ data:
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: Google Sheets API documentation
url: https://developers.google.com/sheets/api
type: api_reference
- title: OAuth 2.0
url: https://developers.google.com/identity/protocols/oauth2
type: authentication_guide
- title: Usage limits
url: https://developers.google.com/sheets/api/limits
type: rate_limits
- title: Google Workspace Status
url: https://www.google.com/appsstatus/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -29,4 +29,17 @@ data:
supportLevel: certified
supportsDataActivation: true
supportsRefreshes: true # needed for the CDK to work as it relies on the generation/sync ids to work
externalDocumentationUrls:
- title: HubSpot API documentation
url: https://developers.hubspot.com/docs/api/overview
type: api_reference
- title: OAuth
url: https://developers.hubspot.com/docs/api/oauth-quickstart-guide
type: authentication_guide
- title: Rate limits
url: https://developers.hubspot.com/docs/api/usage-details
type: rate_limits
- title: HubSpot Status
url: https://status.hubspot.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -32,4 +32,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Apache Iceberg documentation
url: https://iceberg.apache.org/docs/latest/
type: api_reference
- title: Iceberg specification
url: https://iceberg.apache.org/spec/
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,14 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: Apache Kafka documentation
url: https://kafka.apache.org/documentation/
type: api_reference
- title: Security
url: https://kafka.apache.org/documentation/#security
type: authentication_guide
- title: Quotas
url: https://kafka.apache.org/documentation/#design_quotas
type: rate_limits
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,11 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Keen documentation
url: https://keen.io/docs/
type: api_reference
- title: Authentication
url: https://keen.io/docs/api/#authentication
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,20 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Kinesis documentation
url: https://docs.aws.amazon.com/kinesis/
type: api_reference
- title: IAM authentication
url: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
type: authentication_guide
- title: IAM policies
url: https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html
type: permissions_scopes
- title: Quotas and limits
url: https://docs.aws.amazon.com/streams/latest/dev/service-sizes-and-limits.html
type: rate_limits
- title: AWS Service Health Dashboard
url: https://health.aws.amazon.com/health/status
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,8 @@ data:
supportLevel: community
connectorTestSuitesOptions:
- suite: unitTests
externalDocumentationUrls:
- title: KVDB documentation
url: https://kvdb.io/
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -38,4 +38,8 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: LangChain documentation
url: https://python.langchain.com/docs/get_started/introduction
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,8 @@ data:
supportLevel: community
tags:
- language:java
externalDocumentationUrls:
- title: JSON specification
url: https://www.json.org/
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,11 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: MariaDB ColumnStore documentation
url: https://mariadb.com/kb/en/mariadb-columnstore/
type: api_reference
- title: SQL reference
url: https://mariadb.com/kb/en/sql-statements/
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Meilisearch documentation
url: https://www.meilisearch.com/docs
type: api_reference
- title: Authentication
url: https://www.meilisearch.com/docs/learn/security/master_api_keys
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -1,10 +1,10 @@
data:
allowedHosts:
hosts:
- "${indexing.host}"
- ${indexing.host}
- api.openai.com
- api.cohere.ai
- "${embedding.api_base}"
- ${embedding.api_base}
registryOverrides:
cloud:
enabled: true
@@ -13,7 +13,6 @@ data:
resourceRequirements:
jobSpecific:
- jobType: sync
# TODO: Remove once https://github.com/airbytehq/airbyte/issues/30611 is resolved
resourceRequirements:
memory_limit: 2Gi
memory_request: 2Gi
@@ -54,4 +53,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Milvus documentation
url: https://milvus.io/docs
type: api_reference
- title: Authentication
url: https://milvus.io/docs/authenticate.md
type: authentication_guide
- title: Release notes
url: https://milvus.io/docs/release_notes.md
type: api_release_history
metadataSpecVersion: "1.0"

View File

@@ -30,4 +30,17 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: MongoDB documentation
url: https://www.mongodb.com/docs/
type: api_reference
- title: Authentication
url: https://www.mongodb.com/docs/manual/core/authentication/
type: authentication_guide
- title: Role-based access control
url: https://www.mongodb.com/docs/manual/core/authorization/
type: permissions_scopes
- title: MongoDB Status
url: https://status.mongodb.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -28,4 +28,17 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: MongoDB documentation
url: https://www.mongodb.com/docs/
type: api_reference
- title: Authentication
url: https://www.mongodb.com/docs/manual/core/authentication/
type: authentication_guide
- title: Role-based access control
url: https://www.mongodb.com/docs/manual/core/authorization/
type: permissions_scopes
- title: MongoDB Status
url: https://status.mongodb.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -56,4 +56,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: MotherDuck documentation
url: https://motherduck.com/docs
type: api_reference
- title: Authentication
url: https://motherduck.com/docs/key-tasks/authenticating-and-connecting-to-motherduck/
type: authentication_guide
- title: MotherDuck Status
url: https://status.motherduck.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,8 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: MQTT specification
url: https://mqtt.org/mqtt-specification/
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -46,4 +46,17 @@ data:
supportsRefreshes: true
tags:
- language:java
externalDocumentationUrls:
- title: SQL Server documentation
url: https://learn.microsoft.com/en-us/sql/sql-server/
type: api_reference
- title: Transact-SQL reference
url: https://learn.microsoft.com/en-us/sql/t-sql/language-reference
type: sql_reference
- title: Authentication and authorization
url: https://learn.microsoft.com/en-us/sql/relational-databases/security/authentication-access/getting-started-with-database-engine-permissions
type: authentication_guide
- title: Permissions
url: https://learn.microsoft.com/en-us/sql/relational-databases/security/permissions-database-engine
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -44,4 +44,17 @@ data:
supportsDbt: true
tags:
- language:java
externalDocumentationUrls:
- title: MySQL documentation
url: https://dev.mysql.com/doc/
type: api_reference
- title: SQL statement syntax
url: https://dev.mysql.com/doc/refman/8.0/en/sql-statements.html
type: sql_reference
- title: Access control and account management
url: https://dev.mysql.com/doc/refman/8.0/en/access-control.html
type: authentication_guide
- title: GRANT statement
url: https://dev.mysql.com/doc/refman/8.0/en/grant.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -56,4 +56,17 @@ data:
supportsDbt: true
tags:
- language:java
externalDocumentationUrls:
- title: MySQL documentation
url: https://dev.mysql.com/doc/
type: api_reference
- title: SQL statement syntax
url: https://dev.mysql.com/doc/refman/8.0/en/sql-statements.html
type: sql_reference
- title: Access control and account management
url: https://dev.mysql.com/doc/refman/8.0/en/access-control.html
type: authentication_guide
- title: GRANT statement
url: https://dev.mysql.com/doc/refman/8.0/en/grant.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -35,4 +35,17 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: Oracle Database documentation
url: https://docs.oracle.com/en/database/
type: api_reference
- title: SQL language reference
url: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/
type: sql_reference
- title: Database authentication
url: https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/configuring-authentication.html
type: authentication_guide
- title: Managing security
url: https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -45,4 +45,17 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Oracle Database documentation
url: https://docs.oracle.com/en/database/
type: api_reference
- title: SQL language reference
url: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/
type: sql_reference
- title: Database authentication
url: https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/configuring-authentication.html
type: authentication_guide
- title: Managing security
url: https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -50,4 +50,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: pgvector documentation
url: https://github.com/pgvector/pgvector
type: api_reference
- title: PostgreSQL documentation
url: https://www.postgresql.org/docs/current/
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -57,4 +57,20 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Pinecone documentation
url: https://docs.pinecone.io/
type: api_reference
- title: Authentication
url: https://docs.pinecone.io/guides/get-started/authentication
type: authentication_guide
- title: Rate limits
url: https://docs.pinecone.io/troubleshooting/rate-limits
type: rate_limits
- title: Release notes
url: https://docs.pinecone.io/release-notes
type: api_release_history
- title: Pinecone Status
url: https://status.pinecone.io/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -38,4 +38,17 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: PostgreSQL documentation
url: https://www.postgresql.org/docs/current/
type: api_reference
- title: SQL commands
url: https://www.postgresql.org/docs/current/sql-commands.html
type: sql_reference
- title: Client authentication
url: https://www.postgresql.org/docs/current/client-authentication.html
type: authentication_guide
- title: Database roles and privileges
url: https://www.postgresql.org/docs/current/user-manag.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -47,4 +47,17 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: PostgreSQL documentation
url: https://www.postgresql.org/docs/current/
type: api_reference
- title: SQL commands
url: https://www.postgresql.org/docs/current/sql-commands.html
type: sql_reference
- title: Client authentication
url: https://www.postgresql.org/docs/current/client-authentication.html
type: authentication_guide
- title: Database roles and privileges
url: https://www.postgresql.org/docs/current/user-manag.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,20 @@ data:
supportLevel: community
tags:
- language:java
externalDocumentationUrls:
- title: Pub/Sub documentation
url: https://cloud.google.com/pubsub/docs
type: api_reference
- title: Service account authentication
url: https://cloud.google.com/iam/docs/service-accounts
type: authentication_guide
- title: Access control
url: https://cloud.google.com/pubsub/docs/access-control
type: permissions_scopes
- title: Quotas and limits
url: https://cloud.google.com/pubsub/quotas
type: rate_limits
- title: Google Cloud Status
url: https://status.cloud.google.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,11 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Apache Pulsar documentation
url: https://pulsar.apache.org/docs/en/standalone/
type: api_reference
- title: Security
url: https://pulsar.apache.org/docs/en/security-overview/
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -6,10 +6,10 @@ data:
enabled: true
allowedHosts:
hosts:
- "${indexing.url}"
- ${indexing.url}
- api.openai.com
- api.cohere.ai
- "${embedding.api_base}"
- ${embedding.api_base}
resourceRequirements:
jobSpecific:
- jobType: sync
@@ -40,4 +40,14 @@ data:
supportLevel: community
connectorTestSuitesOptions:
- suite: unitTests
externalDocumentationUrls:
- title: Qdrant documentation
url: https://qdrant.tech/documentation/
type: api_reference
- title: Authentication
url: https://qdrant.tech/documentation/guides/security/
type: authentication_guide
- title: Release notes
url: https://github.com/qdrant/qdrant/releases
type: api_release_history
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,17 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Cloudflare R2 documentation
url: https://developers.cloudflare.com/r2/
type: api_reference
- title: Authentication
url: https://developers.cloudflare.com/r2/api/s3/tokens/
type: authentication_guide
- title: Limits
url: https://developers.cloudflare.com/r2/platform/limits/
type: rate_limits
- title: Cloudflare Status
url: https://www.cloudflarestatus.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -36,4 +36,11 @@ data:
# alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: RabbitMQ documentation
url: https://www.rabbitmq.com/documentation.html
type: api_reference
- title: Access control
url: https://www.rabbitmq.com/access-control.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -1,7 +1,7 @@
data:
allowedHosts:
hosts:
- "api.ragie.ai"
- api.ragie.ai
registryOverrides:
oss:
enabled: true
@@ -25,4 +25,8 @@ data:
tags:
- language:python
- cdk:python
externalDocumentationUrls:
- title: Ragie documentation
url: https://docs.ragie.ai/
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,14 @@ data:
connectorTestSuitesOptions:
- suite: unitTests
- suite: integrationTests
externalDocumentationUrls:
- title: Redis documentation
url: https://redis.io/docs/
type: api_reference
- title: Redis ACL
url: https://redis.io/docs/management/security/acl/
type: permissions_scopes
- title: Release notes
url: https://redis.io/docs/about/releases/
type: api_release_history
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,14 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Redpanda documentation
url: https://docs.redpanda.com/
type: api_reference
- title: Authentication
url: https://docs.redpanda.com/docs/manage/security/authentication/
type: authentication_guide
- title: Redpanda Cloud Status
url: https://status.redpanda.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -91,4 +91,23 @@ data:
supportsRefreshes: true
tags:
- language:java
externalDocumentationUrls:
- title: Release notes
url: https://docs.aws.amazon.com/redshift/latest/mgmt/release-notes.html
type: api_release_history
- title: SQL reference
url: https://docs.aws.amazon.com/redshift/latest/dg/c_SQL_reference.html
type: sql_reference
- title: Database authentication
url: https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html
type: authentication_guide
- title: Access control
url: https://docs.aws.amazon.com/redshift/latest/dg/r_GRANT.html
type: permissions_scopes
- title: Quotas and limits
url: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html
type: rate_limits
- title: AWS Service Health Dashboard
url: https://health.aws.amazon.com/health/status
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -20,4 +20,14 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Rockset documentation
url: https://rockset.com/docs/
type: api_reference
- title: API reference
url: https://rockset.com/docs/rest-api/
type: api_reference
- title: Authentication
url: https://rockset.com/docs/rest-api/#authentication
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -44,4 +44,14 @@ data:
supportsRefreshes: true
tags:
- language:java
externalDocumentationUrls:
- title: AWS S3 documentation
url: https://docs.aws.amazon.com/s3/
type: api_reference
- title: IAM authentication
url: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
type: authentication_guide
- title: Bucket policies and permissions
url: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -29,4 +29,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: AWS Glue documentation
url: https://docs.aws.amazon.com/glue/
type: api_reference
- title: IAM authentication
url: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
type: authentication_guide
- title: IAM policies
url: https://docs.aws.amazon.com/glue/latest/dg/security-iam.html
type: permissions_scopes
metadataSpecVersion: "1.0"

View File

@@ -10,9 +10,13 @@ data:
name: S3
connectorIPCOptions:
dataChannel:
version: "0.0.2"
supportedSerialization: ["JSONL", "PROTOBUF"]
supportedTransport: ["SOCKET", "STDIO"]
version: 0.0.2
supportedSerialization:
- JSONL
- PROTOBUF
supportedTransport:
- SOCKET
- STDIO
connectorBuildOptions:
baseImage: docker.io/airbyte/java-connector-base:2.0.1@sha256:ec89bd1a89e825514dd2fc8730ba299a3ae1544580a078df0e35c5202c2085b3
registryOverrides:
@@ -143,4 +147,20 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: AWS S3 documentation
url: https://docs.aws.amazon.com/s3/
type: api_reference
- title: IAM authentication
url: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
type: authentication_guide
- title: Bucket policies and permissions
url: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html
type: permissions_scopes
- title: Request rate and performance
url: https://docs.aws.amazon.com/AmazonS3/latest/userguide/optimizing-performance.html
type: rate_limits
- title: AWS Service Health Dashboard
url: https://health.aws.amazon.com/health/status
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,14 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: ScyllaDB documentation
url: https://docs.scylladb.com/
type: api_reference
- title: CQL reference
url: https://docs.scylladb.com/stable/cql/
type: sql_reference
- title: Authentication
url: https://docs.scylladb.com/stable/operating-scylla/security/authentication.html
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,8 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: SelectDB documentation
url: https://en.selectdb.com/docs
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,8 @@ data:
tags:
- language:python
- cdk:python
externalDocumentationUrls:
- title: SFTP protocol documentation
url: https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer
type: api_reference
metadataSpecVersion: "1.0"

View File

@@ -12,10 +12,20 @@ data:
icon: icon.svg
license: ELv2
name: SingleStore
releaseDate:
releaseDate: null
supportLevel: community
releaseStage: alpha
documentationUrl: https://docs.airbyte.com/integrations/destinations/singlestore
tags:
- language:java
externalDocumentationUrls:
- title: SingleStore documentation
url: https://docs.singlestore.com/
type: api_reference
- title: SQL reference
url: https://docs.singlestore.com/db/latest/reference/sql-reference/
type: sql_reference
- title: Authentication
url: https://docs.singlestore.com/db/latest/security/authentication/
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -51,4 +51,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Snowflake Cortex documentation
url: https://docs.snowflake.com/en/user-guide/snowflake-cortex
type: api_reference
- title: Snowflake SQL reference
url: https://docs.snowflake.com/en/sql-reference
type: sql_reference
- title: Key pair authentication
url: https://docs.snowflake.com/en/user-guide/key-pair-auth
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -15,9 +15,13 @@ data:
name: Snowflake
connectorIPCOptions:
dataChannel:
version: "0.0.2"
supportedSerialization: ["JSONL", "PROTOBUF"]
supportedTransport: ["SOCKET", "STDIO"]
version: 0.0.2
supportedSerialization:
- JSONL
- PROTOBUF
supportedTransport:
- SOCKET
- STDIO
connectorBuildOptions:
baseImage: docker.io/airbyte/java-connector-base:2.0.3@sha256:119b8506bca069bbc8357a275936c7e2b0994e6947b81f1bf8d6ce9e16db7d47
registryOverrides:
@@ -82,4 +86,20 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Release notes
url: https://docs.snowflake.com/en/release-notes
type: api_release_history
- title: SQL reference
url: https://docs.snowflake.com/en/sql-reference
type: sql_reference
- title: Key pair authentication
url: https://docs.snowflake.com/en/user-guide/key-pair-auth
type: authentication_guide
- title: Access control
url: https://docs.snowflake.com/en/user-guide/security-access-control
type: permissions_scopes
- title: Snowflake Status
url: https://status.snowflake.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -27,4 +27,11 @@ data:
- suite: integrationTests
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: SQLite documentation
url: https://www.sqlite.org/docs.html
type: api_reference
- title: SQL reference
url: https://www.sqlite.org/lang.html
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Starburst Galaxy documentation
url: https://docs.starburst.io/starburst-galaxy/
type: api_reference
- title: SQL reference
url: https://docs.starburst.io/latest/sql.html
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -45,6 +45,11 @@ data:
supportLevel: community
connectorTestSuitesOptions:
- suite: unitTests
# - suite: integrationTests
# - suite: acceptanceTests
externalDocumentationUrls:
- title: SurrealDB documentation
url: https://surrealdb.com/docs
type: api_reference
- title: Authentication
url: https://surrealdb.com/docs/surrealdb/security/authentication
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -50,4 +50,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Teradata documentation
url: https://docs.teradata.com/
type: api_reference
- title: SQL reference
url: https://docs.teradata.com/r/Teradata-VantageTM-SQL-Data-Definition-Language-Syntax-and-Examples/July-2021
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -26,4 +26,14 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: TiDB documentation
url: https://docs.pingcap.com/tidb/stable
type: api_reference
- title: SQL reference
url: https://docs.pingcap.com/tidb/stable/sql-statement-overview
type: sql_reference
- title: TiDB Cloud Status
url: https://status.tidbcloud.com/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -36,4 +36,11 @@ data:
# alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: Timeplus documentation
url: https://docs.timeplus.com/
type: api_reference
- title: SQL reference
url: https://docs.timeplus.com/sql-reference
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Typesense documentation
url: https://typesense.org/docs/
type: api_reference
- title: Authentication
url: https://typesense.org/docs/latest/api/authentication.html
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -2,7 +2,7 @@ data:
allowedHosts:
hosts:
- api.vectara.io
- "vectara-prod-${self.customer_id}.auth.us-west-2.amazoncognito.com"
- vectara-prod-${self.customer_id}.auth.us-west-2.amazoncognito.com
registryOverrides:
oss:
enabled: true
@@ -38,4 +38,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Vectara documentation
url: https://docs.vectara.com/
type: api_reference
- title: Authentication
url: https://docs.vectara.com/docs/learn/authentication/auth-overview
type: authentication_guide
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,11 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: Vertica documentation
url: https://www.vertica.com/docs/latest/HTML/Content/Home.htm
type: api_reference
- title: SQL reference
url: https://www.vertica.com/docs/latest/HTML/Content/Authoring/SQLReferenceManual/SQLReferenceManual.htm
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -57,4 +57,14 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Weaviate documentation
url: https://weaviate.io/developers/weaviate
type: api_reference
- title: Authentication
url: https://weaviate.io/developers/weaviate/configuration/authentication
type: authentication_guide
- title: Release notes
url: https://weaviate.io/developers/weaviate/release-notes
type: api_release_history
metadataSpecVersion: "1.0"

View File

@@ -33,4 +33,14 @@ data:
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:4.0.0@sha256:d9894b6895923b379f3006fa251147806919c62b7d9021b5cd125bb67d7bbe22
externalDocumentationUrls:
- title: Xata documentation
url: https://xata.io/docs
type: api_reference
- title: Authentication
url: https://xata.io/docs/concepts/api-keys
type: authentication_guide
- title: Xata Status
url: https://status.xata.io/
type: status_page
metadataSpecVersion: "1.0"

View File

@@ -34,4 +34,11 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
externalDocumentationUrls:
- title: Yellowbrick documentation
url: https://docs.yellowbrick.com/
type: api_reference
- title: SQL reference
url: https://docs.yellowbrick.com/6.7.1/sql_reference/sql_reference.html
type: sql_reference
metadataSpecVersion: "1.0"

View File

@@ -21,4 +21,14 @@ data:
sl: 100
ql: 100
supportLevel: archived
externalDocumentationUrls:
- title: YugabyteDB documentation
url: https://docs.yugabyte.com/
type: api_reference
- title: YSQL reference
url: https://docs.yugabyte.com/preview/api/ysql/
type: sql_reference
- title: Authentication
url: https://docs.yugabyte.com/preview/secure/authentication/
type: authentication_guide
metadataSpecVersion: "1.0"