Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document breaking API changes from per-project data organization (required ?projectId=, removed promptFeatureExtractionId)

Aperta
  • Qualcosa non va?
#1,304 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
api, backend-api-design, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

type: documentation

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

  1. ?projectId= is now required on submit and scoped list operations (ProjectIdQuerySchema + getQueryProjectId throw 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.
  2. promptFeatureExtractionId is removed from the submit body, RequestDocument, and the response schema, and the prompt-feature-extractions collection 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
Lingua principale
TypeScript
Stelle
7
Fork
13
Merge medio
3g 8h
PR unite (30g)
29

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di microsoft/scope

Tutte le issue di microsoft/scope

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.