Skip to content

Commit 27970d4

Browse files
committed
docs: refactored the jsdocs
TICKET: WP-5445
1 parent d3d6669 commit 27970d4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

modules/express/src/typedRoutes/api/v2/signerMacaroon.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ import { BitgoExpressError } from '../../schemas/error';
88
* @property {string} walletId - The ID of the wallet.
99
*/
1010
export const SignerMacaroonParams = {
11+
/** A lightning coin name (e.g, lnbtc). */
1112
coin: t.string,
13+
/** The ID of the wallet. */
1214
walletId: t.string,
1315
} as const;
1416

@@ -18,7 +20,9 @@ export const SignerMacaroonParams = {
1820
* @property {boolean} addIpCaveatToMacaroon - If true, adds an IP caveat to the generated signer macaroon.
1921
*/
2022
export const SignerMacaroonBody = {
23+
/** Passphrase to decrypt the admin macaroon of the signer node. */
2124
passphrase: t.string,
25+
/** If true, adds an IP caveat to the generated signer macaroon. */
2226
addIpCaveatToMacaroon: optional(t.boolean),
2327
} as const;
2428

@@ -30,7 +34,9 @@ export const SignerMacaroonBody = {
3034
* See platform spec: POST /api/v2/{coin}/wallet/{walletId}/signermacaroon
3135
*/
3236
export const SignerMacaroonResponse = {
37+
/** The updated wallet with the generated signer macaroon. */
3338
200: t.UnknownRecord,
39+
/** BitGo Express error payload. */
3440
400: BitgoExpressError,
3541
} as const;
3642

0 commit comments

Comments
 (0)