Skip to content

Commit 5016e6a

Browse files
authored
docs(express): updated JS doc
2 parents edeae0d + d99f3bf commit 5016e6a

18 files changed

+18
-0
lines changed

modules/express/src/typedRoutes/api/v1/acceptShare.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export const AcceptShareRequestBody = {
2222
* When a wallet is shared with a user, they need to accept the share to gain access
2323
* to the wallet according to the permissions granted by the sharing user.
2424
*
25+
* @tag express
2526
* @operationId express.v1.wallet.acceptShare
2627
*/
2728
export const PostAcceptShare = httpRoute({

modules/express/src/typedRoutes/api/v1/consolidateUnspents.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ export const ConsolidateUnspentsResponse = t.array(
7171
* multiple inputs to a single output. This is useful for reducing the number of UTXOs in a wallet,
7272
* which can improve performance and reduce transaction fees.
7373
*
74+
* @tag express
7475
* @operationId express.v1.wallet.consolidateunspents
7576
*/
7677
export const PutConsolidateUnspents = httpRoute({

modules/express/src/typedRoutes/api/v1/constructPendingApprovalTx.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export const ConstructPendingApprovalTxResponse = t.type({
5959
* For transaction request type approvals, either a wallet passphrase or xprv must be provided to sign the transaction.
6060
* You can optionally specify fee-related parameters to customize the transaction fee.
6161
*
62+
* @tag express
6263
* @operationId express.v1.pendingapproval.constructTx
6364
*/
6465
export const PutConstructPendingApprovalTx = httpRoute({

modules/express/src/typedRoutes/api/v1/createLocalKeyChain.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ export const CreateLocalKeyChainResponse = t.type({
3333
* For security reasons, it is highly recommended that you encrypt and destroy
3434
* the original xprv immediately to prevent theft.
3535
*
36+
* @tag express
3637
* @operationId express.v1.keychain.local
3738
*/
3839
export const PostCreateLocalKeyChain = httpRoute({

modules/express/src/typedRoutes/api/v1/deriveLocalKeyChain.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export const DeriveLocalKeyChainResponse = t.type({
4444
* both the derived xprv and xpub are returned. If xpub is provided, only the
4545
* derived xpub is returned.
4646
*
47+
* @tag express
4748
* @operationId express.v1.keychain.derive
4849
*/
4950
export const PostDeriveLocalKeyChain = httpRoute({

modules/express/src/typedRoutes/api/v1/fanoutUnspents.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export const FanoutUnspentsResponse = t.type({
5959
* multiple inputs to multiple outputs. This is useful for increasing the number of UTXOs
6060
* in a wallet, which can improve transaction parallelization.
6161
*
62+
* @tag express
6263
* @operationId express.v1.wallet.fanoutunspents
6364
*/
6465
export const PutFanoutUnspents = httpRoute({

modules/express/src/typedRoutes/api/v1/pendingApproval.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export const pendingApprovalRequestBody = {
2828
* Handles various approval scenarios including transaction approvals, policy rule changes,
2929
* and user change requests.
3030
*
31+
* @tag express
3132
* @operationId express.v1.pendingapprovals
3233
*/
3334

modules/express/src/typedRoutes/api/v1/signTransaction.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ export const signTransactionRequestBody = {
3131
* signTransaction
3232
* Sign a previously created transaction with a keychain
3333
*
34+
* @tag express
3435
* @operationId express.v1.wallet.signTransaction
3536
*/
3637
export const PostSignTransaction = httpRoute({

modules/express/src/typedRoutes/api/v1/simpleCreate.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ export const SimpleCreateRequestBody = {
3131
* 4. Creates the BitGo key on the service
3232
* 5. Creates the wallet on BitGo with the 3 public keys above
3333
*
34+
* @tag express
3435
* @operationId express.v1.wallet.simplecreate
3536
*/
3637
export const PostSimpleCreate = httpRoute({

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ export const CoinSignTxResponse = {
137137
* - pubKeys: Public keys for multi-signature transactions
138138
* - isEvmBasedCrossChainRecovery: For EVM cross-chain recovery
139139
*
140+
* @tag express
140141
* @operationId express.v2.coin.signtx
141142
*/
142143
export const PostCoinSignTx = httpRoute({

0 commit comments

Comments
 (0)