refactor(express): split ping endpoint into v1 and v2

TICKET: WCI-187

Author: rishikeshdadam136

modules/express/src/clientRoutes.ts

@@ -76,7 +76,7 @@ const BITGOEXPRESS_USER_AGENT = `BitGoExpress/${pjson.version} BitGoJS/${version
 const FORWARDED_HEADERS = ['x-bitgo-otp'];
 
 function handlePing(
-  req: ExpressApiRouteRequest<'express.ping', 'get'>,
+  req: ExpressApiRouteRequest<'express.v2.ping', 'get'>,
   res: express.Response,
   next: express.NextFunction
 ) {
@@ -1694,7 +1694,8 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
   const router = createExpressRouter();
   app.use(router);
 
-  router.get('express.ping', [prepareBitGo(config), typedPromiseWrapper(handlePing)]);
+  router.get('express.v1.ping', [prepareBitGo(config), typedPromiseWrapper(handlePing)]);
+  router.get('express.v2.ping', [prepareBitGo(config), typedPromiseWrapper(handlePing)]);
   router.get('express.pingExpress', [typedPromiseWrapper(handlePingExpress)]);
 
   // auth

modules/express/src/typedRoutes/api/index.ts

@@ -2,7 +2,8 @@ import * as t from 'io-ts';
 import { apiSpec } from '@api-ts/io-ts-http';
 import * as express from 'express';
 
-import { GetPing } from './common/ping';
+import { GetV1Ping } from './v1/ping';
+import { GetV2Ping } from './v2/ping';
 import { GetPingExpress } from './common/pingExpress';
 import { PostLogin } from './common/login';
 import { PostDecrypt } from './common/decrypt';
@@ -63,8 +64,11 @@ import { GetResourceDelegations } from './v2/resourceDelegations';
 // inference stays small; (2) only construct expressApi with a single key and add it to the type union at the end.
 
 export const ExpressPingApiSpec = apiSpec({
-  'express.ping': {
-    get: GetPing,
+  'express.v1.ping': {
+    get: GetV1Ping,
+  },
+  'express.v2.ping': {
+    get: GetV2Ping,
   },
 });
 

…press/src/typedRoutes/api/common/ping.ts …s/express/src/typedRoutes/api/v1/ping.tsmodules/express/src/typedRoutes/api/common/ping.ts renamed to modules/express/src/typedRoutes/api/v1/ping.ts modules/express/src/typedRoutes/api/common/ping.ts renamed to modules/express/src/typedRoutes/api/v1/ping.ts

@@ -3,13 +3,13 @@ import { httpRoute, httpRequest } from '@api-ts/io-ts-http';
 import { BitgoExpressError } from '../../schemas/error';
 
 /**
- * Ping
+ * Ping (v1)
  *
- * @operationId express.ping
- * @tag express
+ * @operationId express.v1.ping
+ * @tag Express
  */
-export const GetPing = httpRoute({
-  path: '/api/v[12]/ping',
+export const GetV1Ping = httpRoute({
+  path: '/api/v1/ping',
   method: 'GET',
   request: httpRequest({}),
   response: {

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

@@ -0,0 +1,21 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+/**
+ * Ping
+ *
+ * Health check endpoint that returns 200 when the Express server is running.
+ *
+ * @operationId express.v2.ping
+ * @tag Express
+ */
+export const GetV2Ping = httpRoute({
+  path: '/api/v2/ping',
+  method: 'GET',
+  request: httpRequest({}),
+  response: {
+    200: t.type({}),
+    404: BitgoExpressError,
+  },
+});