Add ping API method for general health check

serguun42 · Nov 15, 2023 · 7773549 · 7773549
1 parent 6e2daba
commit 7773549
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 31 deletions.
diff --git a/backend/pages/api.js b/backend/pages/api.js
@@ -402,6 +402,10 @@ module.exports = (iModuleDataObject) => {
 				.catch(Logging);
 			break;
 
+			case "ping":
+				GlobalSendCustom(200, "pong");
+			break;
+
 			case "logs":
 				switch (path[3]) {
 					case "post":

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -53,7 +53,3 @@ services:
     restart: always
     volumes:
       - ${FRONTEND_PUBLISH_PATH}:/usr/src/app/mount
-
-networks:
-  default:
-    name: mss-network
diff --git a/frontend/public/docs/api/latest.yml b/frontend/public/docs/api/latest.yml
@@ -24,8 +24,6 @@ tags:
     description: Fetch or sync time (weeks, days, etc.)
   - name: stats
     description: Get overall statistics
-  - name: logs
-    description: Getting logs from some sources (e.g. app)
 
 paths:
   /groups/all:
@@ -149,37 +147,20 @@ paths:
               schema:
                 $ref: '#/components/schemas/SomeError'
 
-  /logs/post:
-    post:
-      description: "Post logs from app, front, etc."
-      operationId: postLogs
+  /ping:
+    get:
+      description: Check service availability
+      operationId: ping
       tags:
-        - logs
-      parameters:
-        - in: query
-          name: source
-          schema:
-            type: string
-          required: true
-          description: >
-            Corresponds for source of logs
-          example: "app"
-      requestBody:
-        description: Actual logs body
-        required: true
-        content:
-          text/plain:
-            schema:
-              type: string
-              example: 'Error NullEx in "app/src/module.kt:42:1337"'
+        - stats
       responses:
-        '202':
-          description: Accepted
+        '200':
+          description: Pong
           content:
             text/plain:
               schema:
                 type: string
-                example: "202 Accepted"
+                example: pong
         default:
           description: Some (un)expected error
           content: