Repository navigation
Commit a5a781b
docs(spec): cite the /ai/models picker decision as cloud ADR-0028 (#24514)
Fixes #24486
Clause-②: no
## What this does
`packages/spec` cited a bare `ADR-0028` beside `GET /api/v1/ai/models`.
A bare number resolves against this repository's registry, where
`docs/adr/0028-metadata-naming-and-namespace-isolation.md` is about
metadata naming. The decision these lines mean is cloud's
`docs/adr/0028-paid-tier-selectable-ai-model.md` (read by triage,
comment 6262456627). AGENTS.md Prime Directive #13 says a cloud decision
is cited from this repo as `cloud ADR-NNNN`, never as a bare number.
This PR qualifies the three lines, in the same wording PR #24482 used
for the client TSDoc and the docs:
- `packages/spec/src/api/protocol.zod.ts:3399`, JSDoc on
`AiModelsResponseSchema`: "plan-filtered picker list (cloud ADR-0028)".
- `packages/spec/src/api/protocol.zod.ts:3402`, JSDoc on `models`:
"exposes the cloud ADR-0028 allowlist".
- `packages/spec/src/api/protocol.test.ts:375`, test comment: "the cloud
ADR-0028 allowlist".
JSDoc and comments only. No `.describe()` string, shape or generated
file moves. `CHANGELOG.md` history is left as written.
A fresh `git grep ADR-0028 -- packages/spec` (excluding `CHANGELOG.md`)
on `origin/main` `959ee317b` finds one more site,
`packages/spec/src/kernel/namespace-prefix.ts:4` ("Namespace-prefix
rules (ADR-0028 current-state contract)"). That one is correct as
written: it means this repository's ADR-0028 (namespace isolation), so
it is not changed.
## Changeset
`.changeset/24486-spec-cloud-adr-0028-citation.md` is a `patch` for
`@objectstack/spec`. The package's `files[]` ships `src/**/*.zod.ts`
verbatim, and the JSDoc reaches the built `.d.ts`: after the build,
`grep -rl "picker list (cloud ADR-0028)" packages/spec/dist` hits
`automation-api.zod-*.d.ts` / `.d.mts`, and the old bare wording has 0
hits. The published surface moves, so `skip-changeset` does not apply.
## Verification
The full run below was on head `e27d6d3f60`, the fix commit. After that,
`origin/main` `6b42b6bc8a` was merged in, giving head `c53d4f840e`. The
diff against main is the same 3 files, and the gate derivation on the
new head is byte-identical (86 commands). On `c53d4f840e` I re-ran the
42 build-free commands: all 37 direct `node scripts/...` gates,
`check:nul-bytes`, `check:changeset-gate-self-tests`,
`check:type-check-coverage`, `check:issue-citations` and
`check:test-source-alias`. All 42 exited 0.
- `pnpm --filter @objectstack/spec build`: exit 0.
- `pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2
src/api/protocol.test.ts`: 1 file, 186 tests passed.
- `pnpm --filter @objectstack/spec run typecheck`: exit 0, including
`check:test-typecheck: OK` over the test layer.
- `node scripts/check-adr-anchors.mjs`: exit 0, "check-adr-anchors: OK
(75 anchored file(s), ... 48594 citation(s) across 6480 file(s) resolve
...)". The script recognises `cloud ADR-NNNN` and skips it.
- `node scripts/pm/dispatch-gates.mjs --commands --repo
objectstack-ai/objectstack` derived 86 commands. All 86 were run, and
`--ran` with exit codes reconciles them: "86 derived famil(ies)
accounted for, 82 run, 4 NOT-MEASURED (4 DERIVED from a recorded exit
3)".
- Green, among others: `check:docs` ("227 generated files in sync with
packages/spec"), `check:api-surface` ("public API surface + factory
signatures unchanged"), `check:authorable-surface`, `check:nul-bytes`,
`check-changeset-no-major`, `check-empty-changeset`,
`check:issue-citations`. `node scripts/check-changeset-fixed.mjs`
(roster under `.changeset`) also passed.
- NOT MEASURED (PREREQUISITE NOT MET, unbuilt sibling packages, left to
CI): `check:doc-formula-expressions` (`@objectstack/formula`),
`check:lean-entry-closure` (`@objectstack/objectql` dist),
`check:dual-build-cjs-loads` (whole-workspace build),
`check:type-check-debt`. None of them reads a comment in
`packages/spec/src/api`.
## Acceptance notes
- `packages/spec/src/kernel/namespace-prefix.ts:4` cites `ADR-0028` and
correctly means this repository's record. It is noted here, not changed.
---
_Generated by [Claude
Code](https://claude.ai/code/session_01D6F9axfoPzR7t8G1J7Ytzz)_
Co-authored-by: Claude <noreply@anthropic.com>1 parent df9d07e commit a5a781b
3 files changed
Lines changed: 13 additions & 3 deletions
File tree
- .changeset
- packages/spec/src/api
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
372 | 372 | | |
373 | 373 | | |
374 | 374 | | |
375 | | - | |
| 375 | + | |
376 | 376 | | |
377 | 377 | | |
378 | 378 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3396 | 3396 | | |
3397 | 3397 | | |
3398 | 3398 | | |
3399 | | - | |
| 3399 | + | |
3400 | 3400 | | |
3401 | 3401 | | |
3402 | | - | |
| 3402 | + | |
3403 | 3403 | | |
3404 | 3404 | | |
3405 | 3405 | | |
| |||
0 commit comments