Skip to content

Commit caf7e6b

Browse files
committed
docs: clean up part 2
Ticket: TW-138
1 parent 0fa06ad commit caf7e6b

File tree

3 files changed

+30
-24
lines changed

3 files changed

+30
-24
lines changed

src/advancedWalletManager/routers/healthCheck.ts

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

1818
/**
19-
* Ping Check
19+
* Ping AWM
20+
*
21+
* Test your connection to the Advanced Wallet Manager (AWM) server.
2022
*
2123
* @tag Advanced Wallets
22-
* @operationId v1.health.ping
23-
* @private
24+
* @operationId v1.health.ping.awm
2425
*/
2526
const PingRoute = httpRoute({
2627
method: 'POST',
@@ -31,11 +32,12 @@ const PingRoute = httpRoute({
3132
});
3233

3334
/**
34-
* Version Check
35+
* Check AWM Version
36+
*
37+
* Check your version of the Advanced Wallet Manager (AWM) server.
3538
*
3639
* @tag Advanced Wallets
37-
* @operationId v1.health.version
38-
* @private
40+
* @operationId v1.health.version.awm
3941
*/
4042
const VersionRoute = httpRoute({
4143
method: 'GET',
@@ -46,10 +48,10 @@ const VersionRoute = httpRoute({
4648
});
4749

4850
export const HealthCheckApiSpec = apiSpec({
49-
'v1.health.ping': {
51+
'v1.health.ping.awm': {
5052
post: PingRoute,
5153
},
52-
'v1.health.version': {
54+
'v1.health.version.awm': {
5355
get: VersionRoute,
5456
},
5557
});
@@ -60,7 +62,7 @@ export function createHealthCheckRouter(): WrappedRouter<typeof HealthCheckApiSp
6062
decodeErrorFormatter: customDecodeErrorFormatter,
6163
});
6264
// Ping endpoint handler
63-
router.post('v1.health.ping', [
65+
router.post('v1.health.ping.awm', [
6466
responseHandler(() =>
6567
Response.ok({
6668
status: 'advanced wallet manager server is ok!',
@@ -70,7 +72,7 @@ export function createHealthCheckRouter(): WrappedRouter<typeof HealthCheckApiSp
7072
]);
7173

7274
// Version endpoint handler
73-
router.get('v1.health.version', [
75+
router.get('v1.health.version.awm', [
7476
responseHandler(() =>
7577
Response.ok({
7678
version: pjson.version,

src/masterBitgoExpress/routers/awmExpressHealth.ts

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

3232
/**
33-
* Ping Check
33+
* Ping AWM & MBE Connection
34+
*
35+
* Test your connection between the Advanced Wallet Manager (AWM) and the Master Bitgo Express (MBE) servers.
3436
*
3537
* @tag Advanced Wallets
3638
* @operationId v1.advancedwalletmanager.ping
37-
* @private
3839
*/
3940
const PingAwmRoute = httpRoute({
4041
method: 'POST',
@@ -45,11 +46,12 @@ const PingAwmRoute = httpRoute({
4546
});
4647

4748
/**
48-
* Version Check
49+
* Check AWM & MBE Version
50+
*
51+
* Check your version of the connection between the Advanced Wallet Manager (AWM) and the Master Bitgo Express (MBE) servers.
4952
*
5053
* @tag Advanced Wallets
5154
* @operationId v1.advancedwalletmanager.version
52-
* @private
5355
*/
5456
const VersionAwmRoute = httpRoute({
5557
method: 'GET',

src/masterBitgoExpress/routers/healthCheck.ts

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

1818
/**
19-
* Ping Check
19+
* Ping MBE
20+
*
21+
* Test your connection to the Master Bitgo Express (MBE) server.
2022
*
2123
* @tag Advanced Wallets
22-
* @operationId v1.health.ping
23-
* @private
24+
* @operationId v1.health.ping.mbe
2425
*/
2526
const PingRoute = httpRoute({
2627
method: 'POST',
@@ -31,11 +32,12 @@ const PingRoute = httpRoute({
3132
});
3233

3334
/**
34-
* Version Check
35+
* Check MBE Version
36+
*
37+
* Check your version of the Master Bitgo Express (MBE) server.
3538
*
3639
* @tag Advanced Wallets
37-
* @operationId v1.health.version
38-
* @private
40+
* @operationId v1.health.version.mbe
3941
*/
4042
const VersionRoute = httpRoute({
4143
method: 'GET',
@@ -46,11 +48,11 @@ const VersionRoute = httpRoute({
4648
});
4749

4850
export const HealthCheckApiSpec = apiSpec({
49-
'v1.health.ping': {
51+
'v1.health.ping.mbe': {
5052
post: PingRoute,
5153
},
5254

53-
'v1.health.version': {
55+
'v1.health.version.mbe': {
5456
get: VersionRoute,
5557
},
5658
});
@@ -64,7 +66,7 @@ export function createHealthCheckRouter(
6466
});
6567

6668
// Ping endpoint handler
67-
router.post('v1.health.ping', [
69+
router.post('v1.health.ping.mbe', [
6870
responseHandler(() =>
6971
Response.ok({
7072
status: `${serverType} server is ok!`,
@@ -74,7 +76,7 @@ export function createHealthCheckRouter(
7476
]);
7577

7678
// Version endpoint handler
77-
router.get('v1.health.version', [
79+
router.get('v1.health.version.mbe', [
7880
responseHandler(() =>
7981
Response.ok({
8082
version: pjson.version,

0 commit comments

Comments
 (0)