From 3a36c1c1fad6e244046fe5d5339098801d8b32b1 Mon Sep 17 00:00:00 2001 From: Lokesh Chandra Date: Wed, 26 Nov 2025 13:55:25 +0530 Subject: [PATCH] docs(express): wallet update api definition Ticket: WP-6996 --- .../express/src/typedRoutes/api/v2/expressWalletUpdate.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/modules/express/src/typedRoutes/api/v2/expressWalletUpdate.ts b/modules/express/src/typedRoutes/api/v2/expressWalletUpdate.ts index dcd56c5743..540873e2a8 100644 --- a/modules/express/src/typedRoutes/api/v2/expressWalletUpdate.ts +++ b/modules/express/src/typedRoutes/api/v2/expressWalletUpdate.ts @@ -23,7 +23,7 @@ export const ExpressWalletUpdateBody = { signerTlsCert: t.string, /** (Optional) The signer macaroon for the lighting signer node. */ signerMacaroon: optional(t.string), - /** The wallet passphrase (used locally to decrypt and sign). */ + /** The wallet passphrase. This is not uploaded to BitGo, but used to decrypt userAuthKey used to sign the request before sending to BitGo. */ passphrase: t.string, } as const; @@ -31,7 +31,7 @@ export const ExpressWalletUpdateBody = { * Response for Express Wallet Update */ export const ExpressWalletUpdateResponse = { - /** Updated Wallet - Returns the wallet with updated Lightning signer configuration */ + /** Success - Returns the wallet with updated Lightning signer configuration */ 200: WalletResponse, /** Bad Request - Invalid parameters or missing required fields */ 400: BitgoExpressError, @@ -44,10 +44,11 @@ export const ExpressWalletUpdateResponse = { /** * Express - Update Wallet * The express update wallet route is meant to be used for lightning (lnbtc/tlnbtc). + * It will produced a signed wallet update request that can be used to update the wallet. * For other coins, use the standard wallet update endpoint. * * @operationId express.wallet.update - * @tag express + * @tag Express */ export const PutExpressWalletUpdate = httpRoute({ path: '/express/api/v2/{coin}/wallet/{id}',