Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
  • Is something wrong?
#1,304 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api, backend-api-design, documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

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
Dominant language
TypeScript
Stars
5
Forks
5
Avg merge
3d 3h
Merged PRs (30d)
26

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/scope

All issues in microsoft/scope

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.