-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Cleaned up JS Doc #168
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
da34701 to
e8e50da
Compare
|
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
39ebcc6 to
c58cf43
Compare
ce0d9a3
Ticket: TW-138
ce0d9a3 to
f1d4c99
Compare
Added missing operation IDs and tags to JS Doc (flagged here). Also cleaned up summaries and descriptions of endpoints.
Ticket: TW-138.