Skip to content

DID-9474: [QA-SDK-NODE] Node server SDK release contract - #17

Merged
botinc-agent[bot] merged 2 commits into
mainfrom
botinc/run-483461e4
Oct 30, 2026
Merged

botinc-agent[bot] merged 2 commits into
mainfrom
botinc/run-483461e4

Conversation

@botinc-agent

@botinc-agent botinc-agent Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Problem

Two documents restated numbers copied from an earlier release and would fall behind on every spec sync, giving readers a false inventory of the SDK. The README said api.md listed "all 257 methods" while the generated reference lists 368, and docs/DESIGN.md described "248 server operations in 47 resources" and said that tree lived in overlay.json, which now holds only naming overrides.

Solution

  • The README points at api.md as the generated reference without restating a method count.
  • docs/DESIGN.md describes the resource tree the same way: generated from openapi/*.json, listed in api.md, with overlay.json for naming overrides only.
  • tests/docs.test.ts checks that api.md's declared count matches its method rows, that the README links to it, and that any count restated in the README or docs/DESIGN.md agrees with the generated reference.

Verification

  • pnpm test: 65 files, 1288 tests pass; pnpm typecheck, pnpm lint, pnpm generate:check (129 files up to date), pnpm build and pnpm check:package pass.
  • The docs guard fails on the previous docs/DESIGN.md wording (248/47 against 368 methods and 68 resources) and passes now.
  • The open spec-sync tree (chore/spec-sync, 370 methods) passes generate:check and its 1286 tests, and carries idWallets.startGoogleWallet plus the digital_credentials models.
  • Both examples were run against local stand-ins: session create/retrieve plus webhook verification, and ES256 access-token verification with getSession.
  • Staging end-to-end could not be run: this checkout has no E2E_STAGING_* credentials or sandbox API key.

@botinc-agent
botinc-agent Bot merged commit 1792ca7 into main Oct 30, 2026
16 checks passed
@botinc-agent
botinc-agent Bot deleted the botinc/run-483461e4 branch October 30, 2026 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant