Document breaking API changes from per-project data organization (required ?projectId=, removed promptFeatureExtractionId)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- typescript
調査の方向性
Start by reviewing requests/index.ts:280 and schemas/request.ts:173, then inspect PR #1241 and the in-repository callers that submit or poll runs. Document the required ?projectId= parameter and removed promptFeatureExtractionId in the release notes or changelog, and verify that no internal caller omits the project parameter. The handling of unknown submit-body fields remains a decision to confirm.
索引モデルが issue の本文から書いたものです。
説明
Original author: @manekinekko
Context
Follow-up from review of #1241 (per-project data organization). The PR introduces backward-incompatible API contract changes that need to be surfaced to consumers.
Problem
?projectId=is now required on submit and scoped list operations (ProjectIdQuerySchema+getQueryProjectIdthrow 400 when absent). Any external caller not updated in this PR — CI scripts, automation, other services, webhooks — starts getting a 400 the moment this deploys. The in-repo CLI and Portal are handled; outside callers are not.promptFeatureExtractionIdis removed from the submit body,RequestDocument, and the response schema, and theprompt-feature-extractionscollection is dropped. Because the submit body schema isn't.strict(), clients still sending the field have it silently stripped (no error), and any consumer reading it off responses will find it gone.
Proposed resolution
- Add these to the PR description and release notes / changelog as explicit breaking changes.
- Audit for any un-migrated internal callers that submit or poll runs without a project, and update them.
- Decide whether unknown submit-body fields should be rejected (
.strict()) so removed/renamed fields fail loudly rather than being silently ignored.
Acceptance criteria
- Breaking changes documented where API consumers will see them.
- No remaining internal caller submits/polls runs without
?projectId=.
Related
- PR #1241 (per-project data organization)
- Inline comments: requests/index.ts:280, schemas/request.ts:173
- 主要言語
- TypeScript
- スター
- 14
- フォーク
- 20
- 平均マージ
- 2日 12時間
- マージ済み PR（30日）
- 28
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/scope のほかの issue
-
type: worker-update
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
type: worker-update
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
type: worker-update
難易度 1/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
Clarify that prompt features only categorize prompts, don't impact runs対応中かも @DerrickUnleashed が 10 日前に担当しました。 オープンauthor: JaGord documentation good first issue UI
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
Submit Run task prompt picker should only search requirement prompts対応中かも @cedricvidal が 76 日前に担当しました。 オープンauthor: cedricvidal bug portal
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
microsoft/scope の issue をすべて見る
似ている issue
-
priority:high
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
immich-app/immich#32426 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue hacktoberfest help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
libredb/libredb-studio#1756 ·
メンテナーはふだん 1 日以内に返信
-
state:triage-needed
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信