docs: Cleaned up JS Doc#168
Merged
Merged
Conversation
vmccarty
force-pushed
the
tw-138-clean-up-js-doc
branch
from
da34701 to
e8e50da
Compare
Contributor
Author
|
I tried asking copilot for a review twice, but it opened up PRs instead 😭 I closed those to keep things cleaner and all on this PR. |
There was a problem hiding this comment.
Pull request overview
This PR improves API documentation by adding missing JSDoc annotations (operation IDs and tags) and standardizing endpoint descriptions across all router files. The changes ensure proper OpenAPI specification generation and provide clearer, more consistent documentation for developers using the Advanced Wallets API.
Key changes:
- Added
@operationIdand@tag Advanced Walletsannotations to all API endpoints - Standardized documentation format with title, description, and cross-references to related endpoints
- Cleaned up existing comments by consolidating multi-line descriptions and removing redundant
@endpointannotations
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/masterBitgoExpress/routers/signAndSendMpcRoute.ts | Added comprehensive JSDoc with operation ID advancedwalletsigntxtss for signing and sending MPC transactions |
| src/masterBitgoExpress/routers/sendManyRoute.ts | Added complete JSDoc with operation ID advancedwalletsendmany for bulk transaction sending |
| src/masterBitgoExpress/routers/recoveryRoute.ts | Cleaned up JSDoc, added operation ID advancedwalletrecovery, and improved description clarity |
| src/masterBitgoExpress/routers/recoveryConsolidationsRoute.ts | Removed redundant @endpoint annotations, added operation ID advancedwalletconsolidaterecovery |
| src/masterBitgoExpress/routers/healthCheck.ts | Added JSDoc for ping and version check endpoints with private tag |
| src/masterBitgoExpress/routers/generateWalletRoute.ts | Expanded JSDoc with operation ID advancedwalletgenerate and detailed step-by-step process |
| src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts | Added JSDoc with operation ID advancedwalletconsolidateunspents for UTXO consolidation |
| src/masterBitgoExpress/routers/consolidateRoute.ts | Added JSDoc with operation ID advancedwalletconsolidate for account-based consolidation |
| src/masterBitgoExpress/routers/awmExpressHealth.ts | Added JSDoc for Advanced Wallet Manager health check endpoints with private tag |
| src/masterBitgoExpress/routers/accelerateRoute.ts | Removed redundant comments, added operation ID advancedwalletacceleratetx |
| src/advancedWalletManager/routers/healthCheck.ts | Added JSDoc for AWM-specific ping and version check endpoints with private tag |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
vmccarty
force-pushed
the
tw-138-clean-up-js-doc
branch
from
39ebcc6 to
c58cf43
Compare
zahin-mohammad
previously approved these changes
Dec 9, 2025
alextse-bg
previously approved these changes
Dec 10, 2025
vmccarty
dismissed stale reviews from alextse-bg and zahin-mohammad
via
ce0d9a3
Ticket: TW-138
vmccarty
force-pushed
the
tw-138-clean-up-js-doc
branch
from
ce0d9a3 to
f1d4c99
Compare
alextse-bg
approved these changes
Dec 10, 2025
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.
Added missing operation IDs and tags to JS Doc (flagged here). Also cleaned up summaries and descriptions of endpoints.
Ticket: TW-138.