Skip to content

docs(openapi): document platform connectors and the platform execute endpoint - #96

Merged
leorfer23 merged 2 commits into
mainfrom
docs/openapi-platform-connectors
Oct 14, 2026
Merged

leorfer23 merged 2 commits into
mainfrom
docs/openapi-platform-connectors

Conversation

@leorfer23

Copy link
Copy Markdown
Contributor

What

The REST API already accepted the new connectors from #90. The OpenAPI spec didn't describe them, so API callers and agents reading /openapi had no way to find them.

  • POST /v1/workspaces/{id}/connections now documents:
    • kind (generic | platform) and provider
    • every credential type, including aws_access_key
    • per-provider config for s3, supabase, redshift and aurora
    • examples for S3, Supabase and Redshift
    • type is no longer marked required, since platform connectors don't use it
  • POST /v1/workspaces/{id}/connections/test: documents the provider ids it accepts.
  • New: POST /v1/data/{artifactId}/platform/{provider}/{endpoint}/execute: covers sql.query (→ { columns, rows }) and S3 objects.list, objects.get and objects.presign, plus who may call it and where to find connection ids.

Regenerated src/discovery (npm run build:discovery):

Checks (run locally)

  • npx tsc --noEmit clean
  • npm test full suite: 545 files, 5178 tests passed, including openapi-contract and seo-discovery
  • pre-push hook passed; gitleaks clean

🤖 Generated with Claude Code

leorfer23 and others added 2 commits October 14, 2026 15:59
…endpoint

The create-connector schema only described generic connectors (`type`), so
API callers and agents reading the spec could not discover platform
connectors at all. Adds `kind`, `provider`, the credential type enum
(incl. `aws_access_key`), per-provider config for s3/supabase/redshift/
aurora, and examples. Documents POST
/v1/data/{artifactId}/platform/{provider}/{endpoint}/execute with the
sql.query and objects.* endpoints.

Regenerated src/discovery: openapi.spec.json and agent-skill.generated.ts
(the embedded skill archive was stale since #90/#94 updated the skill).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…nt main

abb591f changed skill docs without restaging the bundle, which fails the
Bundles check for every PR merged against main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@leorfer23
leorfer23 force-pushed the docs/openapi-platform-connectors branch from 2b81ae4 to 6ff0644 Compare October 14, 2026 19:07
@leorfer23
leorfer23 merged commit 27bd106 into main Oct 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant