docs: correct two stale GraphQL residue sites in package source comments - #11414
Conversation
`packages/spec/src/data/object.zod.ts:252` — the JSDoc on `apiEnabled` said
"Enable REST/GraphQL API access". There is no automatic GraphQL API;
`apiEnabled` gates the automatic REST and MCP surfaces
(`packages/mcp/src/stdio-data-bridge.ts:260` reads `apiEnabled === false`).
The `.describe()` one line below was already correct ("Expose object via
automatic APIs") and is untouched.
`packages/adapters/hono/src/index.ts:105-106` — the `createHonoApp` doc
comment's parenthetical named "GraphQL raw result" among the routes
registered explicitly. `createHonoApp` registers auth (`/auth/*`) and
discovery (`prefix`, `/discovery`, `/.well-known/objectstack`) explicitly,
then one catch-all; no GraphQL route exists
(`packages/runtime/src/http-dispatcher.ts:2087` —
`// /graphql removed — GraphQL is not in the product plan (#2462 follow-on)`).
Comment-only; no behavior, `.describe()`, or schema-shape change.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T9cDbY2NBiVJWYx3BpWfH2
📓 Docs Drift CheckThis PR changes 2 package(s): 2 hand-written doc(s) NAME something this change touched and may need an implementation-accuracy re-verification:
⛔ 1 release-owned page(s) also name something this change touched. These are read-only:
What this run could not see
Coarse fallback — 126 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): Which tree this was computed onThis run read A worktree cut from an older # while this PR is open — GitHub drops the merge commit once it closes
git fetch origin ab546a30fc50ef4e3a8a346ae132cea49c40271e && git checkout ab546a30fc50ef4e3a8a346ae132cea49c40271e
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin bb006446adb558e5a86c009df9c0b08e98833011 07a05a7053d88e99c2ef4586983f4e5987ade710 && git checkout -B drift-repro bb006446adb558e5a86c009df9c0b08e98833011 && git merge --no-ff 07a05a7053d88e99c2ef4586983f4e5987ade710
node scripts/docs-audit/affected-docs.mjs --json bb006446adb558e5a86c009df9c0b08e98833011
|
Fixes #11140
Comment-only fix for two package-source comments that still asserted a
/graphqlsurface the runtime does not mount — same defect class as #10846 / #10710 / #10832 / #10583 / #10835, one surface further in (package source comments rather than the published skill catalog).Sites fixed
packages/spec/src/data/object.zod.ts:252/** Enable REST/GraphQL API access *//** Enable REST/MCP API access */packages/adapters/hono/src/index.ts:105-106Only routes that need framework-specific handling (auth service, GraphQL raw result, discovery wrapper) are registered explicitly.Only routes that need framework-specific handling (auth service, discovery wrapper) are registered explicitly.Neither site's
.describe()(line below theapiEnabledJSDoc) was touched — it already read correctly ("Expose object via automatic APIs").Why
apiEnabledgates the automatic REST and MCP surfaces, not GraphQL —packages/mcp/src/stdio-data-bridge.ts:260readsenable.apiEnabled === false. There is no automatic GraphQL API.createHonoAppregisters auth (app.all(prefix + '/auth/*')) and discovery (app.get(prefix),/discovery,/.well-known/objectstack) explicitly, then one catch-all — no GraphQL route is registered.packages/runtime/src/http-dispatcher.ts:2087carries the authoritative statement:// /graphql removed — GraphQL is not in the product plan (#2462 follow-on).Scope
Comment-only. No behavior change, no
.describe()change, no schema shape change. Exactly the two files/sites named above — nothing else touched.Tests
Run on commit
07a05a7053(current HEAD):git grep -n "GraphQL" -- packages/spec/src/data/object.zod.ts packages/adapters/hono/src/index.ts→ exactly the 2 expected hits.pnpm --filter '@objectstack/spec^...' build→ no workspace deps for spec; command-exit 0.pnpm --filter @objectstack/spec build→ command-exit 0. Confirmed the rebuilt JS bundle (packages/spec/dist/data/index.js) carries the new JSDoc text (Enable REST/MCP API access) and no residualGraphQLtext tied toapiEnabled; the.d.tsoutput does not inline this bare JSDoc at all (only.describe()strings do), socheck:api-surface/check:docsare unaffected by this change — confirmed bycheck:generatedbelow.pnpm --filter @objectstack/spec check:generated→✓ All 14 generated artifacts are up to date(command-exit 0).pnpm --filter @objectstack/spec typecheck→ command-exit 0 (tsc --noEmit+check:scripts-typecheck+check:test-typecheck, pre-existing test-layer debt count unchanged at 263/55 files).pnpm --filter '@objectstack/hono^...' build(deps closure:@objectstack/rest,plugin-auth,@objectstack/runtime, etc.) → command-exit 0.pnpm --filter @objectstack/hono build→ command-exit 0.pnpm --filter @objectstack/hono test -- --maxWorkers=2→Test Files 2 passed (2)/Tests 74 passed (74), command-exit 0.node scripts/check-route-envelope.mjs(matched bynode scripts/pm/dispatch-gates.mjsspecifically viapackages/adapters/hono/src/index.ts) → pre-existing ratchet state unchanged, command-exit 0.git grep -n "createGraphQLDomain" packages/*/src→ 0 hits (unchanged from filing-time verification).Local scope followed the "定向门禁,全农场归 CI" discipline — the full lint farm is CI's to run.
Deviations from the dispatch prompt
None. Both sites were still present on
origin/mainat task start (line numbers matched the prompt's re-verification: object.zod.ts:252 intact, hono sentence spanning :105-:106).premise_still_valid: true.skip-changeset: comment-only diff, no changeset. Adding theskip-changesetlabel next via the additive endpoint per AGENTS.md, then reading it back to confirm it survived.Generated by Claude Code