Skip to content

Conversation

@vmccarty
Copy link
Contributor

@vmccarty vmccarty commented Dec 9, 2025

Added missing operation IDs and tags to JS Doc (flagged here). Also cleaned up summaries and descriptions of endpoints.

Ticket: TW-138.

@vmccarty vmccarty requested a review from a team as a code owner December 9, 2025 22:00
@BitGo BitGo deleted a comment from Copilot AI Dec 9, 2025
@BitGo BitGo deleted a comment from Copilot AI Dec 9, 2025
@vmccarty vmccarty force-pushed the tw-138-clean-up-js-doc branch from da34701 to e8e50da Compare December 9, 2025 22:18
@vmccarty
Copy link
Contributor Author

vmccarty commented Dec 9, 2025

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.

Copy link

Copilot AI left a 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 @operationId and @tag Advanced Wallets annotations 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 @endpoint annotations

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 vmccarty force-pushed the tw-138-clean-up-js-doc branch from 39ebcc6 to c58cf43 Compare December 9, 2025 22:35
zahin-mohammad
zahin-mohammad previously approved these changes Dec 9, 2025
alextse-bg
alextse-bg previously approved these changes Dec 10, 2025
@vmccarty vmccarty dismissed stale reviews from alextse-bg and zahin-mohammad via ce0d9a3 December 10, 2025 16:02
Ticket: TW-138
@alextse-bg alextse-bg merged commit 031e5b1 into master Dec 10, 2025
7 checks passed
@alextse-bg alextse-bg deleted the tw-138-clean-up-js-doc branch December 10, 2025 17:32
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.

4 participants