diff --git a/src/advancedWalletManager/routers/healthCheck.ts b/src/advancedWalletManager/routers/healthCheck.ts index b060626..d0462bc 100644 --- a/src/advancedWalletManager/routers/healthCheck.ts +++ b/src/advancedWalletManager/routers/healthCheck.ts @@ -16,37 +16,43 @@ const VersionResponse: HttpResponse = { }; /** - * Ping Check + * Ping (AWM) + * + * Test your connection to the Advanced Wallet Manager (AWM) server. + * + * @tag Advanced Wallets + * @operationId advancedwallet.awm.ping + */ +const PingRoute = httpRoute({ + method: 'POST', + path: '/ping', + request: httpRequest({}), + response: PingResponse, + description: 'Health check endpoint that returns server status', +}); + +/** + * Check Version (AWM) + * + * Check your version of the Advanced Wallet Manager (AWM) server. * * @tag Advanced Wallets - * @operationId v1.health.ping - * @private + * @operationId advancedwallet.awm.version */ +const VersionRoute = httpRoute({ + method: 'GET', + path: '/version', + request: httpRequest({}), + response: VersionResponse, + description: 'Returns the current version of the server', +}); + export const HealthCheckApiSpec = apiSpec({ - 'v1.health.ping': { - post: httpRoute({ - method: 'POST', - path: '/ping', - request: httpRequest({}), - response: PingResponse, - description: 'Health check endpoint that returns server status', - }), + 'advancedwallet.awm.ping': { + post: PingRoute, }, - /** - * Version Check - * - * @tag Advanced Wallets - * @operationId v1.health.version - * @private - */ - 'v1.health.version': { - get: httpRoute({ - method: 'GET', - path: '/version', - request: httpRequest({}), - response: VersionResponse, - description: 'Returns the current version of the server', - }), + 'advancedwallet.awm.version': { + get: VersionRoute, }, }); @@ -56,7 +62,7 @@ export function createHealthCheckRouter(): WrappedRouter Response.ok({ status: 'advanced wallet manager server is ok!', @@ -66,7 +72,7 @@ export function createHealthCheckRouter(): WrappedRouter Response.ok({ version: pjson.version, diff --git a/src/masterBitgoExpress/clients/advancedWalletManagerClient.ts b/src/masterBitgoExpress/clients/advancedWalletManagerClient.ts index fbfba55..cb6e08e 100644 --- a/src/masterBitgoExpress/clients/advancedWalletManagerClient.ts +++ b/src/masterBitgoExpress/clients/advancedWalletManagerClient.ts @@ -346,7 +346,7 @@ export class AdvancedWalletManagerClient { async ping(): Promise { try { logger.info('Pinging Advanced Wallet Manager at: %s', this.baseUrl); - let request = this.apiClient['v1.health.ping'].post({}); + let request = this.apiClient['advancedwallet.awm.ping'].post({}); if (this.tlsMode === TlsMode.MTLS) { request = request.agent(this.createHttpsAgent()); @@ -371,7 +371,7 @@ export class AdvancedWalletManagerClient { async getVersion(): Promise { try { logger.info('Getting version information from Advanced Wallet Manager'); - let request = this.apiClient['v1.health.version'].get({}); + let request = this.apiClient['advancedwallet.awm.version'].get({}); if (this.tlsMode === TlsMode.MTLS) { request = request.agent(this.createHttpsAgent()); diff --git a/src/masterBitgoExpress/routers/accelerateRoute.ts b/src/masterBitgoExpress/routers/accelerateRoute.ts index 6761d7d..b188aff 100644 --- a/src/masterBitgoExpress/routers/accelerateRoute.ts +++ b/src/masterBitgoExpress/routers/accelerateRoute.ts @@ -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 advancedwalletacceleratetx + * @operationId advancedwallet.accelerate.tx */ export const AccelerateRoute = httpRoute({ method: 'POST', diff --git a/src/masterBitgoExpress/routers/awmExpressHealth.ts b/src/masterBitgoExpress/routers/awmExpressHealth.ts index aac3198..d2d0e00 100644 --- a/src/masterBitgoExpress/routers/awmExpressHealth.ts +++ b/src/masterBitgoExpress/routers/awmExpressHealth.ts @@ -30,37 +30,43 @@ const VersionAwmResponse: HttpResponse = { }; /** - * Ping Check + * Ping (MBE-to-AWM) + * + * Test your connection between the Advanced Wallet Manager (AWM) and the Master Bitgo Express (MBE) servers. + * + * @tag Advanced Wallets + * @operationId advancedwallet.mbe.awm.ping + */ +const PingAwmRoute = httpRoute({ + method: 'POST', + path: '/ping/advancedWalletManager', + request: httpRequest({}), + response: PingAwmResponse, + description: 'Ping the advanced wallet manager server', +}); + +/** + * Check Version (MBE-to-AWM) + * + * Use the Master Bitgo Express (MBE) server to check your version of the Advanced Wallet Manager (AWM) server. Calling this endpoint instructs the MBE server to call [Check AWM Version](https://developers.bitgo.com/reference/v1healthversionawm). * * @tag Advanced Wallets - * @operationId v1.advancedwalletmanager.ping - * @private + * @operationId advancedwallet.mbe.awm.version */ +const VersionAwmRoute = httpRoute({ + method: 'GET', + path: '/version/advancedWalletManager', + request: httpRequest({}), + response: VersionAwmResponse, + description: 'Get the version of the advanced wallet manager server', +}); + export const AdvancedWalletManagerHealthSpec = apiSpec({ - 'v1.advancedwalletmanager.ping': { - post: httpRoute({ - method: 'POST', - path: '/ping/advancedWalletManager', - request: httpRequest({}), - response: PingAwmResponse, - description: 'Ping the advanced wallet manager server', - }), + 'advancedwallet.mbe.awm.ping': { + post: PingAwmRoute, }, - /** - * Version Check - * - * @tag Advanced Wallets - * @operationId v1.advancedwalletmanager.version - * @private - */ - 'v1.advancedwalletmanager.version': { - get: httpRoute({ - method: 'GET', - path: '/version/advancedWalletManager', - request: httpRequest({}), - response: VersionAwmResponse, - description: 'Get the version of the advanced wallet manager server', - }), + 'advancedwallet.mbe.awm.version': { + get: VersionAwmRoute, }, }); @@ -76,7 +82,7 @@ export function createAdvancedWalletManagerHealthRouter( const awmClient = new AdvancedWalletManagerClient(cfg); // Ping endpoint handler - router.post('v1.advancedwalletmanager.ping', [ + router.post('advancedwallet.mbe.awm.ping', [ responseHandler(async () => { logger.debug('Pinging advanced wallet manager'); @@ -101,7 +107,7 @@ export function createAdvancedWalletManagerHealthRouter( }), ]); - router.get('v1.advancedwalletmanager.version', [ + router.get('advancedwallet.mbe.awm.version', [ responseHandler(async () => { try { // Use the client's getVersion method instead of direct HTTP request diff --git a/src/masterBitgoExpress/routers/consolidateRoute.ts b/src/masterBitgoExpress/routers/consolidateRoute.ts index 8204309..e77d3f8 100644 --- a/src/masterBitgoExpress/routers/consolidateRoute.ts +++ b/src/masterBitgoExpress/routers/consolidateRoute.ts @@ -42,7 +42,7 @@ export const ConsolidateResponse: HttpResponse = { * Use this endpoint only with advanced wallets. For other wallet types, use [Consolidate account (simple)](https://developers.bitgo.com/reference/expresswalletconsolidateaccount). * * @tag Advanced Wallets - * @operationId advancedwalletconsolidate + * @operationId advancedwallet.consolidate */ export const ConsolidateRoute = httpRoute({ method: 'POST', diff --git a/src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts b/src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts index b749bad..f2fcfc6 100644 --- a/src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts +++ b/src/masterBitgoExpress/routers/consolidateUnspentsRoute.ts @@ -81,7 +81,7 @@ export const ConsolidateUnspentsResponse: HttpResponse = { * Use this endpoint only with advanced wallets. For other wallet types, use [Consolidate unspents (simple)](https://developers.bitgo.com/reference/expresswalletconsolidateunspents). * * @tag Advanced Wallets - * @operationId advancedwalletconsolidateunspents + * @operationId advancedwallet.consolidate.unspents */ export const ConsolidateUnspentsRoute = httpRoute({ method: 'POST', diff --git a/src/masterBitgoExpress/routers/generateWalletRoute.ts b/src/masterBitgoExpress/routers/generateWalletRoute.ts index 1a9e1c2..6708337 100644 --- a/src/masterBitgoExpress/routers/generateWalletRoute.ts +++ b/src/masterBitgoExpress/routers/generateWalletRoute.ts @@ -342,7 +342,7 @@ const GenerateWalletRequest = { * 5. Creates the wallet on BitGo with the 3 keys. * * @tag Advanced Wallets - * @operationId advancedwalletgenerate + * @operationId advancedwallet.generate */ export const WalletGenerateRoute = httpRoute({ method: 'POST', diff --git a/src/masterBitgoExpress/routers/healthCheck.ts b/src/masterBitgoExpress/routers/healthCheck.ts index 83d64af..fb464a6 100644 --- a/src/masterBitgoExpress/routers/healthCheck.ts +++ b/src/masterBitgoExpress/routers/healthCheck.ts @@ -16,37 +16,44 @@ const VersionResponse: HttpResponse = { }; /** - * Ping Check + * Ping (MBE) + * + * Test your connection to the Master Bitgo Express (MBE) server. * * @tag Advanced Wallets - * @operationId v1.health.ping - * @private + * @operationId advancedwallet.mbe.ping */ +const PingRoute = httpRoute({ + method: 'POST', + path: '/ping', + request: httpRequest({}), + response: PingResponse, + description: 'Health check endpoint that returns server status', +}); + +/** + * Check Version (MBE) + * + * Check your version of the Master Bitgo Express (MBE) server. + * + * @tag Advanced Wallets + * @operationId advancedwallet.mbe.version + */ +const VersionRoute = httpRoute({ + method: 'GET', + path: '/version', + request: httpRequest({}), + response: VersionResponse, + description: 'Returns the current version of the server', +}); + export const HealthCheckApiSpec = apiSpec({ - 'v1.health.ping': { - post: httpRoute({ - method: 'POST', - path: '/ping', - request: httpRequest({}), - response: PingResponse, - description: 'Health check endpoint that returns server status', - }), + 'advancedwallet.mbe.ping': { + post: PingRoute, }, - /** - * Version Check - * - * @tag Advanced Wallets - * @operationId v1.health.version - * @private - */ - 'v1.health.version': { - get: httpRoute({ - method: 'GET', - path: '/version', - request: httpRequest({}), - response: VersionResponse, - description: 'Returns the current version of the server', - }), + + 'advancedwallet.mbe.version': { + get: VersionRoute, }, }); @@ -59,7 +66,7 @@ export function createHealthCheckRouter( }); // Ping endpoint handler - router.post('v1.health.ping', [ + router.post('advancedwallet.mbe.ping', [ responseHandler(() => Response.ok({ status: `${serverType} server is ok!`, @@ -69,7 +76,7 @@ export function createHealthCheckRouter( ]); // Version endpoint handler - router.get('v1.health.version', [ + router.get('advancedwallet.mbe.version', [ responseHandler(() => Response.ok({ version: pjson.version, diff --git a/src/masterBitgoExpress/routers/recoveryConsolidationsRoute.ts b/src/masterBitgoExpress/routers/recoveryConsolidationsRoute.ts index 0b23289..13eeee0 100644 --- a/src/masterBitgoExpress/routers/recoveryConsolidationsRoute.ts +++ b/src/masterBitgoExpress/routers/recoveryConsolidationsRoute.ts @@ -122,7 +122,7 @@ const RecoveryConsolidationsWalletResponse: HttpResponse = { * Use this endpoint only with advanced wallets. For other wallet types, use the [Wallet Recovery Wizard](https://developers.bitgo.com/docs/wallets-recover#/). * * @tag Advanced Wallets - * @operationId advancedwalletconsolidaterecovery + * @operationId advancedwallet.consolidate.recovery */ export const RecoveryConsolidationsRoute = httpRoute({ method: 'POST', diff --git a/src/masterBitgoExpress/routers/recoveryRoute.ts b/src/masterBitgoExpress/routers/recoveryRoute.ts index 88b3cb3..5fa82a2 100644 --- a/src/masterBitgoExpress/routers/recoveryRoute.ts +++ b/src/masterBitgoExpress/routers/recoveryRoute.ts @@ -294,7 +294,7 @@ const RecoveryWalletRequest = { * Use this endpoint only with advanced wallets. For other wallet types, use the [Wallet Recovery Wizard](https://developers.bitgo.com/docs/wallets-recover#/). * * @tag Advanced Wallets - * @operationId advancedwalletrecovery + * @operationId advancedwallet.recovery */ export const RecoveryRoute = httpRoute({ method: 'POST', diff --git a/src/masterBitgoExpress/routers/sendManyRoute.ts b/src/masterBitgoExpress/routers/sendManyRoute.ts index d6bd640..31acfe4 100644 --- a/src/masterBitgoExpress/routers/sendManyRoute.ts +++ b/src/masterBitgoExpress/routers/sendManyRoute.ts @@ -219,7 +219,7 @@ export const SendManyResponse: HttpResponse = { * Use this endpoint only with advanced wallets. For other wallet types, use [Send to many](https://developers.bitgo.com/reference/expresswalletsendmany). * * @tag Advanced Wallets - * @operationId advancedwalletsendmany + * @operationId advancedwallet.sendmany */ export const SendManyRoute = httpRoute({ method: 'POST', diff --git a/src/masterBitgoExpress/routers/signAndSendMpcRoute.ts b/src/masterBitgoExpress/routers/signAndSendMpcRoute.ts index 227c49e..4a5c2e2 100644 --- a/src/masterBitgoExpress/routers/signAndSendMpcRoute.ts +++ b/src/masterBitgoExpress/routers/signAndSendMpcRoute.ts @@ -26,7 +26,7 @@ export const SignMpcResponse: HttpResponse = { * Use this endpoint only with advanced wallets. For other wallet types, use [Sign MPC transaction](https://developers.bitgo.com/reference/expresswalletsigntxtss). * * @tag Advanced Wallets - * @operationId advancedwalletsigntxtss + * @operationId advancedwallet.sign.tx.tss */ export const SignAndSendMpcRoute = httpRoute({ method: 'POST',