docs: Refined ts code and cleaned up JS Doc.

Ticket: TW-138

Author: vmccarty

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 v1.health.ping.awm
+ */
+const PingRoute = httpRoute({
+  method: 'POST',
+  path: '/ping',
+  request: httpRequest({}),
+  response: PingResponse,
+  description: 'Health check endpoint that returns server status',
+});
+
+/**
+ * Check AWM Version
+ *
+ * Check your version of the Advanced Wallet Manager (AWM) server.
  *
  * @tag Advanced Wallets
- * @operationId v1.health.ping
- * @private
+ * @operationId v1.health.version.awm
  */
+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',
-    }),
+  'v1.health.ping.awm': {
+    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',
-    }),
+  'v1.health.version.awm': {
+    get: VersionRoute,
   },
 });
 
@@ -56,7 +62,7 @@ export function createHealthCheckRouter(): WrappedRouter<typeof HealthCheckApiSp
     decodeErrorFormatter: customDecodeErrorFormatter,
   });
   // Ping endpoint handler
-  router.post('v1.health.ping', [
+  router.post('v1.health.ping.awm', [
     responseHandler(() =>
       Response.ok({
         status: 'advanced wallet manager server is ok!',
@@ -66,7 +72,7 @@ export function createHealthCheckRouter(): WrappedRouter<typeof HealthCheckApiSp
   ]);
 
   // Version endpoint handler
-  router.get('v1.health.version', [
+  router.get('v1.health.version.awm', [
     responseHandler(() =>
       Response.ok({
         version: pjson.version,

src/masterBitgoExpress/routers/awmExpressHealth.ts

@@ -30,37 +30,43 @@ const VersionAwmResponse: HttpResponse = {
 };
 
 /**
- * Ping Check
+ * Ping AWM & MBE Connection
+ *
+ * Test your connection between the Advanced Wallet Manager (AWM) and the Master Bitgo Express (MBE) servers.
  *
  * @tag Advanced Wallets
  * @operationId v1.advancedwalletmanager.ping
- * @private
  */
+const PingAwmRoute = httpRoute({
+  method: 'POST',
+  path: '/ping/advancedWalletManager',
+  request: httpRequest({}),
+  response: PingAwmResponse,
+  description: 'Ping the advanced wallet manager server',
+});
+
+/**
+ * Check AWM & MBE Version
+ *
+ * Check your version of the connection between the Advanced Wallet Manager (AWM) and the Master Bitgo Express (MBE) servers.
+ *
+ * @tag Advanced Wallets
+ * @operationId v1.advancedwalletmanager.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',
-    }),
+    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',
-    }),
+    get: VersionAwmRoute,
   },
 });
 

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 v1.health.ping.mbe
  */
+const PingRoute = httpRoute({
+  method: 'POST',
+  path: '/ping',
+  request: httpRequest({}),
+  response: PingResponse,
+  description: 'Health check endpoint that returns server status',
+});
+
+/**
+ * Check MBE Version
+ *
+ * Check your version of the Master Bitgo Express (MBE) server.
+ *
+ * @tag Advanced Wallets
+ * @operationId v1.health.version.mbe
+ */
+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',
-    }),
+  'v1.health.ping.mbe': {
+    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',
-    }),
+
+  'v1.health.version.mbe': {
+    get: VersionRoute,
   },
 });
 
@@ -59,7 +66,7 @@ export function createHealthCheckRouter(
   });
 
   // Ping endpoint handler
-  router.post('v1.health.ping', [
+  router.post('v1.health.ping.mbe', [
     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('v1.health.version.mbe', [
     responseHandler(() =>
       Response.ok({
         version: pjson.version,