Skip to content

Commit 6822ce9

Browse files
committed
docs: edits
Ticket: TW-138
1 parent 8ea5e14 commit 6822ce9

4 files changed

Lines changed: 26 additions & 26 deletions

File tree

src/advancedWalletManager/routers/healthCheck.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ const VersionResponse: HttpResponse = {
1616
};
1717

1818
/**
19-
* Ping AWM
19+
* Ping (AWM)
2020
*
2121
* Test your connection to the Advanced Wallet Manager (AWM) server.
2222
*
2323
* @tag Advanced Wallets
24-
* @operationId v1.health.ping.awm
24+
* @operationId v1.advancedwallet.awm.ping
2525
*/
2626
const PingRoute = httpRoute({
2727
method: 'POST',
@@ -32,12 +32,12 @@ const PingRoute = httpRoute({
3232
});
3333

3434
/**
35-
* Check AWM Version
35+
* Check Version (AWM)
3636
*
3737
* Check your version of the Advanced Wallet Manager (AWM) server.
3838
*
3939
* @tag Advanced Wallets
40-
* @operationId v1.health.version.awm
40+
* @operationId v1.advancedwallet.awm.version
4141
*/
4242
const VersionRoute = httpRoute({
4343
method: 'GET',
@@ -48,10 +48,10 @@ const VersionRoute = httpRoute({
4848
});
4949

5050
export const HealthCheckApiSpec = apiSpec({
51-
'v1.health.ping.awm': {
51+
'v1.advancedwallet.awm.ping': {
5252
post: PingRoute,
5353
},
54-
'v1.health.version.awm': {
54+
'v1.advancedwallet.awm.version': {
5555
get: VersionRoute,
5656
},
5757
});
@@ -62,7 +62,7 @@ export function createHealthCheckRouter(): WrappedRouter<typeof HealthCheckApiSp
6262
decodeErrorFormatter: customDecodeErrorFormatter,
6363
});
6464
// Ping endpoint handler
65-
router.post('v1.health.ping.awm', [
65+
router.post('v1.advancedwallet.awm.ping', [
6666
responseHandler(() =>
6767
Response.ok({
6868
status: 'advanced wallet manager server is ok!',
@@ -72,7 +72,7 @@ export function createHealthCheckRouter(): WrappedRouter<typeof HealthCheckApiSp
7272
]);
7373

7474
// Version endpoint handler
75-
router.get('v1.health.version.awm', [
75+
router.get('v1.advancedwallet.awm.version', [
7676
responseHandler(() =>
7777
Response.ok({
7878
version: pjson.version,

src/masterBitgoExpress/clients/advancedWalletManagerClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ export class AdvancedWalletManagerClient {
346346
async ping(): Promise<PingResponseType> {
347347
try {
348348
logger.info('Pinging Advanced Wallet Manager at: %s', this.baseUrl);
349-
let request = this.apiClient['v1.health.ping'].post({});
349+
let request = this.apiClient['v1.advancedwallet.awm.ping'].post({});
350350

351351
if (this.tlsMode === TlsMode.MTLS) {
352352
request = request.agent(this.createHttpsAgent());

src/masterBitgoExpress/routers/awmExpressHealth.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ const VersionAwmResponse: HttpResponse = {
3030
};
3131

3232
/**
33-
* Ping AWM & MBE Connection
33+
* Ping (MBE-to-AWM)
3434
*
3535
* Test your connection between the Advanced Wallet Manager (AWM) and the Master Bitgo Express (MBE) servers.
3636
*
3737
* @tag Advanced Wallets
38-
* @operationId v1.advancedwalletmanager.ping
38+
* @operationId v1.advancedwallet.ping
3939
*/
4040
const PingAwmRoute = httpRoute({
4141
method: 'POST',
@@ -46,12 +46,12 @@ const PingAwmRoute = httpRoute({
4646
});
4747

4848
/**
49-
* Check AWM & MBE Version
49+
* Check Version (MBE-to-AWM)
5050
*
51-
* Check your version of the connection between the Advanced Wallet Manager (AWM) and the Master Bitgo Express (MBE) servers.
51+
* 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).
5252
*
5353
* @tag Advanced Wallets
54-
* @operationId v1.advancedwalletmanager.version
54+
* @operationId v1.advancedwallet.version
5555
*/
5656
const VersionAwmRoute = httpRoute({
5757
method: 'GET',
@@ -62,10 +62,10 @@ const VersionAwmRoute = httpRoute({
6262
});
6363

6464
export const AdvancedWalletManagerHealthSpec = apiSpec({
65-
'v1.advancedwalletmanager.ping': {
65+
'v1.advancedwallet.ping': {
6666
post: PingAwmRoute,
6767
},
68-
'v1.advancedwalletmanager.version': {
68+
'v1.advancedwallet.version': {
6969
get: VersionAwmRoute,
7070
},
7171
});
@@ -82,7 +82,7 @@ export function createAdvancedWalletManagerHealthRouter(
8282
const awmClient = new AdvancedWalletManagerClient(cfg);
8383

8484
// Ping endpoint handler
85-
router.post('v1.advancedwalletmanager.ping', [
85+
router.post('v1.advancedwallet.ping', [
8686
responseHandler(async () => {
8787
logger.debug('Pinging advanced wallet manager');
8888

@@ -107,7 +107,7 @@ export function createAdvancedWalletManagerHealthRouter(
107107
}),
108108
]);
109109

110-
router.get('v1.advancedwalletmanager.version', [
110+
router.get('v1.advancedwallet.version', [
111111
responseHandler(async () => {
112112
try {
113113
// Use the client's getVersion method instead of direct HTTP request

src/masterBitgoExpress/routers/healthCheck.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ const VersionResponse: HttpResponse = {
1616
};
1717

1818
/**
19-
* Ping MBE
19+
* Ping (MBE)
2020
*
2121
* Test your connection to the Master Bitgo Express (MBE) server.
2222
*
2323
* @tag Advanced Wallets
24-
* @operationId v1.health.ping.mbe
24+
* @operationId v1.advancedwallet.mbe.ping
2525
*/
2626
const PingRoute = httpRoute({
2727
method: 'POST',
@@ -32,12 +32,12 @@ const PingRoute = httpRoute({
3232
});
3333

3434
/**
35-
* Check MBE Version
35+
* Check Version (MBE)
3636
*
3737
* Check your version of the Master Bitgo Express (MBE) server.
3838
*
3939
* @tag Advanced Wallets
40-
* @operationId v1.health.version.mbe
40+
* @operationId v1.advancedwallet.mbe.version
4141
*/
4242
const VersionRoute = httpRoute({
4343
method: 'GET',
@@ -48,11 +48,11 @@ const VersionRoute = httpRoute({
4848
});
4949

5050
export const HealthCheckApiSpec = apiSpec({
51-
'v1.health.ping.mbe': {
51+
'v1.advancedwallet.mbe.ping': {
5252
post: PingRoute,
5353
},
5454

55-
'v1.health.version.mbe': {
55+
'v1.advancedwallet.mbe.version': {
5656
get: VersionRoute,
5757
},
5858
});
@@ -66,7 +66,7 @@ export function createHealthCheckRouter(
6666
});
6767

6868
// Ping endpoint handler
69-
router.post('v1.health.ping.mbe', [
69+
router.post('v1.advancedwallet.mbe.ping', [
7070
responseHandler(() =>
7171
Response.ok({
7272
status: `${serverType} server is ok!`,
@@ -76,7 +76,7 @@ export function createHealthCheckRouter(
7676
]);
7777

7878
// Version endpoint handler
79-
router.get('v1.health.version.mbe', [
79+
router.get('v1.advancedwallet.mbe.version', [
8080
responseHandler(() =>
8181
Response.ok({
8282
version: pjson.version,

0 commit comments

Comments
 (0)