Skip to content

Correct X-Kernel-Project-Id: header takes a project ID, not a name#414

Open
IlyaasK wants to merge 2 commits into
mainfrom
fix-project-header-id-only
Open

Correct X-Kernel-Project-Id: header takes a project ID, not a name#414
IlyaasK wants to merge 2 commits into
mainfrom
fix-project-header-id-only

Conversation

@IlyaasK

@IlyaasK IlyaasK commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

What

docs#409 described the X-Kernel-Project-Id header as accepting "a project ID or name." It does not — the middleware resolves it by project ID only (entproject.IDEQ), so a name returns 404 project_not_found. Verified live against a running API: the project name testingapikeygen 404'd, its ID resolved.

Fix

Clarify that the header takes a project ID; name resolution is a client-side convenience (the CLI's --project flag and the SDKs resolve names to IDs before sending the header). The CLI section of this page already documents --project <id-or-name> correctly and is unchanged.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only correction with no runtime or API behavior changes.

Overview
Fixes misleading docs in Scoping Requests to a Project (info/projects.mdx): X-Kernel-Project-Id is documented as accepting only a project ID, not a name (names in the header lead to 404 project_not_found).

The section now explains that CLI --project and SDK project settings resolve names to IDs before sending the header, while direct REST callers must set the header to the ID themselves. Default-project behavior when the header is omitted is unchanged.

Reviewed by Cursor Bugbot for commit ee5ece8. Bugbot is set up for automated code reviews on this repo. Configure here.

The header is resolved server-side by project ID only (the middleware looks
up entproject.IDEQ); passing a name returns 404 project_not_found. Name
resolution is a client-side convenience — the CLI's --project flag and the
SDKs resolve names to IDs before sending the header. docs#409 incorrectly
said the header accepts "a project ID or name".

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@IlyaasK IlyaasK requested a review from AnnaXWang June 22, 2026 14:25
@firetiger-agent

Copy link
Copy Markdown

Created a monitoring plan for this PR.

What this PR does: Fixes a documentation inaccuracy — the X-Kernel-Project-Id header only accepts a project ID, not a project name. Developers who previously passed a name would have received a 404 project_not_found error with no clear explanation in the docs.

Intended effect:

  • No production telemetry signal exists for a docs-only change. Confirmation is manual: the published info/projects page should render correctly and show the corrected header description after merge.

Risks:

  • Broken page render — MDX parse error causes the docs page to 404; alert if info/projects returns a non-200 after publish.
  • Inaccurate correction — if the fix misstates the actual API behavior, developers using a project name would still receive 404 project_not_found; alert if project_not_found errors rise unexpectedly in API logs post-merge (baseline: pre-existing low-level noise, no sustained increase expected).

View monitor

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

This PR changes one sentence in info/projects.mdx to clarify that X-Kernel-Project-Id accepts a project ID, while CLI/SDK name resolution happens before sending the header. The diff is documentation-only, limited to a single page, and doesn't change navigation, configuration, generated API specs, runtime code, infrastructure, auth, or security-sensitive behavior.

I didn't find a CODEOWNERS file requiring owner review, and there were no existing approvals, so I'm approving.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

…t-API detail

Per review: don't steer users to hunt for and paste an opaque project ID.
Scope by name via the CLI --project flag or an SDK client (both resolve the
name to the ID); the raw X-Kernel-Project-Id header (ID-only) is documented as
the underlying mechanism for direct REST callers.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Jun 22, 2026, 2:29 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The current diff modifies a single sentence in info/projects.mdx to clarify project scoping guidance: CLI/SDK usage can be name-based while direct REST calls send X-Kernel-Project-Id as a project ID. This is documentation-only, limited to one page, and doesn't change navigation, configuration, generated API specs, runtime code, infrastructure, auth, or security-sensitive behavior.

I didn't find a CODEOWNERS file requiring owner review. This PR was already approved by this automation on an earlier commit, and the synchronized update doesn't increase risk, so I'm not re-approving or dismissing the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

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.

2 participants