docs(rpc): sync to nearcore 2.13.0 + view_state pagination curation#5
Merged
Conversation
This was referenced Jul 14, 2026
…ields
Sync the generated RPC reference to the nearcore 2.13.0 release tag and add a
per-operation field-description override layer to humanize the pagination fields
nearcore shipped without doc comments.
nearcore 2.13.0 sync (npm run generate-rpc against the 2.13.0 tag):
- view_state: new after_key_base64 / limit / last_key pagination fields
- view_access_key_list: post-quantum (ML-DSA-65) access-key wording
- client_config / genesis_config / EXPERIMENTAL_protocol_config: config fields
- provenance recorded in shared/generatedNearcoreSource.json (tag 2.13.0)
Field-description machinery:
- new applyFieldDescriptions() + op.fieldDescriptions.{request,response} in
generate-from-nearcore.js: per-op overrides that win by presence and reach
leaf-type-filled request fields and response fields, which PARAM_DESCRIPTIONS
cannot
- curated after_key_base64 / limit / last_key wording for view_state; clears the
one audit:parameter-descriptions gap
- recovered the richer view_state prefix_base64 description (live on builder-docs
but missing from mike-docs main) into the operation map via the new layer
- documented the layer in AGENTS.md and PORTAL_WORKFLOW.md
drafts/nearcore-openapi-field-descriptions-issue.md: draft upstream issue asking
nearcore to backfill field-level docs (referenced by the operation-map comment).
Validated: audit:parameter-descriptions (0), audit:description-quality (0/0),
audit:page-model-routes, audit:structured-graph, redocly lint.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mikedotexe
force-pushed
the
docs/nearcore-2.13.0-rpc
branch
from
July 14, 2026 21:43
8a8ee7b to
519aadc
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Main PR: fastnear/builder-docs#28. This is the supporting generation PR. Syncs the generated RPC reference to the nearcore 2.13.0 release tag and adds a per-operation field-description override layer.
nearcore 2.13.0 sync
npm run generate-rpcagainst the 2.13.0 tag (its committedopenapi.jsonis the schemars/Rust-annotation output, CI-guaranteed viajust openapi-spec):after_key_base64/limit/last_keypagination fieldsshared/generatedNearcoreSource.json(tag2.13.0)Field-description machinery
applyFieldDescriptions()+op.fieldDescriptions.{request,response}ingenerate-from-nearcore.js— per-op overrides that win by presence and reach leaf-type-filled request fields and response fields (whichPARAM_DESCRIPTIONScannot)after_key_base64/limit/last_keywording for view_state; clears the oneaudit:parameter-descriptionsgapprefix_base64description (live on builder-docs, missing from mike-docs main) into the operation map via the new layerAGENTS.mdandPORTAL_WORKFLOW.mddrafts/nearcore-openapi-field-descriptions-issue.md— draft of the upstream nearcore issue asking for field-level doc backfill.Validation
audit:parameter-descriptions(0),audit:description-quality(0/0),audit:page-model-routes,audit:structured-graph, redocly lint — all green.🤖 Generated with Claude Code