airbytehq / airbytehq/airbyte-api-python-sdk

Add SDK support for workspace connector skill docs

オープン
#211 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Python
スター
61
フォーク
27
平均マージ
4分
マージ済み PR(30日)
2

説明

The new Cloud workspace connector documentation endpoint needs typed SDK support when its public specification is published.

Platform implementation: https://github.com/airbytehq/airbyte-platform-internal/pull/19464.

Add `GET /v1/workspaces/{workspaceId}/skills/docs` under the Workspaces SDK group (`getSkillDocs` alias). Require `id=connector-source:`; accept an optional exact `section` from the default response outline. The identifier is a source instance UUID, not a connector definition ID.

Preserve the complete typed response: `metadata`, `outline`, nullable `section_id`, and `content`; metadata includes freshness and warnings. Support all five content block variants (`heading`, `paragraph`, `list`, `code`, `table`), explicit nullable fields, empty arrays, and `kind=connector_source` only. Library skills are excluded.

This read-only endpoint returns YAML-derived documentation, which can describe capabilities outside Cloud source execution's current scope. Reading docs grants no execution access. Availability is controlled and defaults off; workspace reader access, existing Agents enrollment, and source enablement are required. Handle sanitized problem responses for 401, 403, 404, 413, 422, 501, 502, 503, and 504.

- [ ] Regenerate from the published `api_sdk.yaml` and expose the Workspaces operation and typed models.
- [ ] Add wire tests for default docs and exact-section requests, all five block variants, explicit nulls, empty arrays, warnings, and sanitized problem responses.
- [ ] Coordinate the SDK release with public-spec publication and Cloud rollout.

Paired E2E remains pending. This issue tracks generation and release; it does not claim an SDK release or production activation.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Once the public api_sdk.yaml is published, start by regenerating the SDK and inspect the Workspaces operation and typed models for getSkillDocs. Add wire coverage for default and exact-section requests, all five content blocks, nulls, empty arrays, warnings, and sanitized problem responses. Done means the generated operation and models are exposed and release coordination is ready for spec publication and Cloud rollout.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。