Skip to content

docs: Fix JSDoc inconsistencies and operationId typo #169

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.

Sign up for GitHub

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

Closed
Copilot wants to merge 3 commits into from
Closed

docs: Fix JSDoc inconsistencies and operationId typo #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2335511
Initial plan
Copilot Dec 9, 2025
cf741dd
fix: Improve JSDoc descriptions and fix typo in operationId
Copilot Dec 9, 2025
20b528b
docs: Improve consolidateUnspents route description
Copilot Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/advancedWalletManager/routers/advancedWalletManagerApiSpec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ export const AdvancedWalletManagerApiSpec = apiSpec({
body: RecoveryMultisigRequest,
}),
response: RecoveryMultisigResponse,
description: 'Recover a multisig transaction',
description: 'Sign a multisig recovery transaction',
}),
},
'v1.mpc.recovery': {
Expand Down Expand Up @@ -355,7 +355,7 @@ export const AdvancedWalletManagerApiSpec = apiSpec({
body: IndependentKeyRequest,
}),
response: IndependentKeyResponse,
description: 'Generate an independent key',
description: 'Generate an independent keychain',
}),
},
'v1.mpc.key.initialize': {
Expand Down Expand Up @@ -392,7 +392,7 @@ export const AdvancedWalletManagerApiSpec = apiSpec({
body: SignMpcRequest,
}),
response: SignMpcResponse,
description: 'Sign a MPC transaction',
description: 'Sign an MPC transaction',
}),
},

Expand Down Expand Up @@ -423,7 +423,7 @@ export const AdvancedWalletManagerApiSpec = apiSpec({
200: MpcV2InitializeResponseType,
...ErrorResponses,
},
description: 'Initialize MPC for EdDSA key generation',
description: 'Initialize MPC v2 for ECDSA key generation',
}),
},
'v1.mpcv2.round': {
Expand All @@ -438,7 +438,7 @@ export const AdvancedWalletManagerApiSpec = apiSpec({
200: MpcV2RoundResponseType,
...ErrorResponses,
},
description: 'Perform a round in the MPC protocol',
description: 'Perform a round in the MPC v2 DKG protocol',
}),
},
'v1.mpcv2.finalize': {
Expand All @@ -453,7 +453,7 @@ export const AdvancedWalletManagerApiSpec = apiSpec({
200: MpcV2FinalizeResponseType,
...ErrorResponses,
},
description: 'Finalize the MPC protocol',
description: 'Finalize the MPC v2 DKG protocol',
}),
},
'v1.mpcv2.recovery': {
Expand All @@ -468,7 +468,7 @@ export const AdvancedWalletManagerApiSpec = apiSpec({
200: MpcV2RecoveryResponseType,
...ErrorResponses,
},
description: 'Recover a MPC transaction',
description: 'Sign an MPC v2 recovery transaction',
}),
},
});
Expand Down
2 changes: 1 addition & 1 deletion src/masterBitgoExpress/routers/accelerateRoute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ const AccelerateResponse: HttpResponse = {
* Use this endpoint only with advanced wallets. For other wallet types, use [Accelerate Transaction](https://developers.bitgo.com/reference/expresswalletacceleratetx).
*
* @tag Advanced Wallets
* @operationId advancedwalletalletacceleratetx
* @operationId advancedwalletacceleratetx
*/
export const AccelerateRoute = httpRoute({
method: 'POST',
Expand Down
1 change: 1 addition & 0 deletions src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,5 @@ export const ConsolidateUnspentsRoute = httpRoute({
body: ConsolidateUnspentsRequest,
}),
response: ConsolidateUnspentsResponse,
description: 'Build, sign, and send a transaction to consolidate unspents for UTXO-based assets',
});