docs: Fix JSDoc inconsistencies and operationId typo #169
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
Merged
- Fixed typo in accelerate route operationId (advancedwalletalletacceleratetx -> advancedwalletacceleratetx) - Added missing description to consolidateUnspents route - Improved description clarity and consistency across API spec: - Changed "Recover a multisig transaction" to "Sign a multisig recovery transaction" - Changed "Generate an independent key" to "Generate an independent keychain" - Changed "Sign a MPC transaction" to "Sign an MPC transaction" - Changed "Initialize MPC for EdDSA key generation" to "Initialize MPC v2 for ECDSA key generation" - Changed "Perform a round in the MPC protocol" to "Perform a round in the MPC v2 DKG protocol" - Changed "Finalize the MPC protocol" to "Finalize the MPC v2 DKG protocol" - Changed "Recover a MPC transaction" to "Sign an MPC v2 recovery transaction" Co-authored-by: vmccarty <107434158+vmccarty@users.noreply.github.com>
Made description more detailed to match the level of JSDoc comments Co-authored-by: vmccarty <107434158+vmccarty@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update JS Doc with missing operation IDs and tags
docs: Fix JSDoc inconsistencies and operationId typo
Dec 9, 2025
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.
Code review identified inconsistencies in API endpoint descriptions and a typo in an operationId affecting OpenAPI spec generation.
Changes
Fixed operationId typo
advancedwalletalletacceleratetx→advancedwalletacceleratetxImproved description specificity
Added missing descriptions
consolidateUnspentsroute now has full description matching JSDoc detail levelExamples
Before:
After:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.