feat: Add websocket tags and real-time log endpoint, update Swagger U…

…I tags sorter
lifegpc · Jan 9, 2025 · ad3e836 · ad3e836
1 parent bbfa06c
commit ad3e836
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/api.yml b/api.yml
@@ -1422,7 +1422,7 @@ paths:
                 { "ok": false, "status": 403, "error": "Permission denied." }
   /config:
     get:
-      tags: [config, admin]
+      tags: [config, admin, websocket]
       operationId: getConfig
       summary: Get server's configuration
       parameters:
@@ -2842,6 +2842,29 @@ paths:
                 $ref: "#/components/schemas/ApiResponseError"
               example:
                 { "ok": false, "status": 404, "error": "log not found." }
+  /log/realtime:
+    get:
+      tags: [logs, websocket]
+      summary: Create a websocket connection to receive real-time log
+      operationId: getRealtimeLogs
+      responses:
+        "101":
+          description: Switching Protocols to websocket
+        "401":
+          description: Authorization information is missing or invalid
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponseError"
+              example: { "ok": false, "status": 401, "error": "Unauthorized" }
+        "403":
+          description: Permission denied
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponseError"
+              example:
+                { "ok": false, "status": 403, "error": "Permission denied." }
   /shared_token:
     delete: 
       tags: [token]
@@ -3202,7 +3225,7 @@ paths:
                 { "ok": false, "status": 403, "error": "Permission denied." }
   /task:
     get:
-      tags: [task]
+      tags: [task, websocket]
       operationId: createTaskConnection
       summary: Create a websocket connection to receive task event
       responses: 

diff --git a/static/swagger-initializer.js b/static/swagger-initializer.js
@@ -15,6 +15,7 @@ window.onload = function() {
     ],
     layout: "StandaloneLayout",
     validatorUrl: null,
+    tagsSorter: 'alpha',
   });
 
   //</editor-fold>