Skip to content

docs(api): add the 4.2.0 API reference JSON and v4-2-0 tree - #4550

Merged
bpamiri merged 2 commits into
developfrom
peter/api-json-4.2.0
Oct 11, 2026
Merged

bpamiri merged 2 commits into
developfrom
peter/api-json-4.2.0

Conversation

@bpamiri

@bpamiri bpamiri commented Oct 11, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

release.yml builds the wheels lookup docs index with build-docs-index.mjs --strict --version $WHEELS_VERSION, which reads the committed docs/api/v<version>.json. A 4.2.0 release fails without docs/api/v4.2.0.json, as 4.1.0 needed v4.1.0.json. The step runs before anything publishes, so a missing file fails safely, but it still has to be here before the release merge.

The file is the API JSON the develop snapshot build generated on c3665d9 (Wheels Snapshots run 38071933831, artifact api-docs-snapshot, from /wheels/api?format=json&type=core), copied unchanged. It contains no version string. It has 406 functions, against 388 in v4.1.0.json.

It also adds the generated web/sites/api/src/content/docs/v4-2-0/ tree (node web/scripts/generate-api-docs.mjs 4.2.0): 406 function pages across 10 sections, 19 more than v4-1-0 and none removed. API_VERSIONS doesn't list it yet; the versions flip (#4322) makes it current.

Release-prep PR: it merges as part of the 4.2.0 cut. If framework code changes the public API before the tag, it needs regenerating.

Checks

  • jq -e '.functions and .sections'
  • node web/scripts/generate-api-docs.mjs 4.2.0 regenerates the tree with no diff
  • node tools/build/scripts/build-docs-index.mjs --strict --version 4.2.0 (exactly what release.yml runs on main) passes: 406 API entries from v4.2.0.json, 1785 guide sections from v4-2-0

🤖 Generated with Claude Code

release.yml builds the `wheels lookup` docs index with --strict against
docs/api/v<version>.json, so the 4.2.0 release needs this file committed.
It is the API JSON that the develop snapshot build generated on c3665d9
(/wheels/api?format=json&type=core), unchanged: 406 functions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@github-actions github-actions Bot added the docs label Oct 11, 2026
node web/scripts/generate-api-docs.mjs 4.2.0, from docs/api/v4.2.0.json:
406 function pages across 10 sections (19 more than v4-1-0, none removed).
The tree isn't listed as current until the 4.2.0 versions flip.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@bpamiri bpamiri changed the title docs(api): add the 4.2.0 API reference JSON docs(api): add the 4.2.0 API reference JSON and v4-2-0 tree Oct 11, 2026
@bpamiri

bpamiri commented Oct 11, 2026

Copy link
Copy Markdown
Collaborator Author

Review: head 1e4fb64. APPROVE (ready to merge for the 4.2.0 cut).

  • The JSON is generated, not hand-edited. docs/api/v4.2.0.json is byte-identical (cmp) to the api-docs-snapshot artifact (v4.2.0-snapshot.json) from Wheels Snapshots run 38071933831, which ran on develop c3665d9 and succeeded.
  • The tree is generated from that JSON. In a clean worktree at this head, node web/scripts/generate-api-docs.mjs 4.2.0 reports "Generated 406 function pages across 10 sections" and leaves git status empty, so the committed web/sites/api/src/content/docs/v4-2-0/ tree is exactly the generator's output.
  • Strict docs index. node tools/build/scripts/build-docs-index.mjs --strict --version 4.2.0 (the release.yml step) passes: 406 API entries from v4.2.0.json and 1785 guide sections from v4-2-0.
  • Builds. PR CI's Deploy api, Deploy guides (and blog, landing and packages), Visual regression and the web/scripts node tests all pass. Overall: 20 pass, 0 fail, 3 skipped.
  • Scope. API_VERSIONS doesn't list v4-2-0 yet, which is correct: docs(web): make the 4.2 guides, API reference and home page links current #4322 makes it current. As the PR says, any public-API change before the tag means regenerating both the JSON and the tree.

@bpamiri
bpamiri merged commit c1e1f81 into develop Oct 11, 2026
26 checks passed
@bpamiri
bpamiri deleted the peter/api-json-4.2.0 branch October 11, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant