Correct X-Kernel-Project-Id: header takes a project ID, not a name#414
Correct X-Kernel-Project-Id: header takes a project ID, not a name#414IlyaasK wants to merge 2 commits into
Conversation
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>
|
Created a monitoring plan for this PR. What this PR does: Fixes a documentation inaccuracy — the Intended effect:
Risks:
|
There was a problem hiding this comment.
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.
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>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
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.
Sent by Cursor Automation: Assign PR reviewers


What
docs#409 described the
X-Kernel-Project-Idheader as accepting "a project ID or name." It does not — the middleware resolves it by project ID only (entproject.IDEQ), so a name returns404 project_not_found. Verified live against a running API: the project nametestingapikeygen404'd, its ID resolved.Fix
Clarify that the header takes a project ID; name resolution is a client-side convenience (the CLI's
--projectflag 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-Idis documented as accepting only a project ID, not a name (names in the header lead to404 project_not_found).The section now explains that CLI
--projectand 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.