add doc of GET /v1/version (#44)

Signed-off-by: cbh778899 <[email protected]>
SkywardAI · Aug 12, 2024 · dcb5c00 · dcb5c00
1 parent 800a2a1
commit dcb5c00
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/swagger.json b/swagger.json
@@ -32,6 +32,10 @@
     {
       "name": "Token",
       "description": "v1 Token APIs"
+    },
+    {
+      "name": "Version",
+      "description": "v1 Version APIs"
     }
   ],
   "paths": {
@@ -343,6 +347,30 @@
           }
         }
       }
+    },
+    "/v1/version": {
+      "get": {
+        "summary": "Get engine versions",
+        "description": "Get version of various engines used by this project",
+        "tags": ["Version"],
+        "responses": {
+          "200": {
+            "description": "Get a json of versions",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "inference_engine_version": {
+                      "type": "string",
+                      "examples": ["server--b1-2321a5e"]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {