Repository navigation
DID-9474: [QA-SDK-NODE] Node server SDK release contract - #17
Merged
Merged
Conversation
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
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.
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.mdlisted "all 257 methods" while the generated reference lists 368, anddocs/DESIGN.mddescribed "248 server operations in 47 resources" and said that tree lived inoverlay.json, which now holds only naming overrides.Solution
api.mdas the generated reference without restating a method count.docs/DESIGN.mddescribes the resource tree the same way: generated fromopenapi/*.json, listed inapi.md, withoverlay.jsonfor naming overrides only.tests/docs.test.tschecks thatapi.md's declared count matches its method rows, that the README links to it, and that any count restated in the README ordocs/DESIGN.mdagrees 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 buildandpnpm check:packagepass.docs/DESIGN.mdwording (248/47 against 368 methods and 68 resources) and passes now.chore/spec-sync, 370 methods) passesgenerate:checkand its 1286 tests, and carriesidWallets.startGoogleWalletplus thedigital_credentialsmodels.getSession.E2E_STAGING_*credentials or sandbox API key.