feat: implement a /v2/ping endpoint WEB-981 (#602)

Author: sylvain-morin

openapi/paths/v2/ping.js

@@ -0,0 +1,37 @@
+module.exports = sendWrapper => {
+  async function GET( req, res ) {
+    sendWrapper( req, res, null, { status: "available" } );
+  }
+
+  GET.apiDoc = {
+    tags: ["Ping"],
+    summary: "Check API availability",
+    responses: {
+      200: {
+        description: "A simple availability response",
+        content: {
+          "application/json": {
+            schema: {
+              type: "object",
+              properties: {
+                status: {
+                  type: "string",
+                  example: "available"
+                }
+              },
+              required: ["status"]
+            }
+          }
+        }
+      },
+      default: {
+        $ref: "#/components/responses/Error"
+      }
+    },
+    "x-default-ttl": -1
+  };
+
+  return {
+    GET
+  };
+};

test/integration/v2/ping.js

@@ -0,0 +1,19 @@
+const { expect } = require( "chai" );
+const request = require( "supertest" );
+
+describe( "Ping", ( ) => {
+  describe( "index", ( ) => {
+    it( "renders a ping response", function ( done ) {
+      request( this.app ).get( "/v2/ping" )
+        .expect( res => {
+          expect( res.body.status ).to.eq( "available" );
+          expect( res.headers["cache-control"] ).to.eq(
+            "private, no-cache, no-store, must-revalidate"
+          );
+          expect( res.headers.expires ).to.eq( "-1" );
+          expect( res.headers.pragma ).to.eq( "no-cache" );
+        } ).expect( "Content-Type", /json/ )
+        .expect( 200, done );
+    } );
+  } );
+} );