Add Server API to OpenAPI

2026-03-02 22:19:40 +00:00 · 2024-11-09 22:47:18 +00:00 · 2024-11-09 22:47:18 +00:00 · 31df862c32
commit 31df862c32
parent d7e810fc2f
2 changed files with 34 additions and 0 deletions
--- a/docs/controllers/ServerController.yaml
+++ b/docs/controllers/ServerController.yaml
@ -0,0 +1,30 @@
+paths:
+  /ping:
+    get:
+      operationId: ping
+      summary: Ping the server
+      description: This endpoint is a simple check to see if the server is operating and responding with JSON correctly.
+      tags:
+        - Server
+      responses:
+        200:
+          description: ping OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+  /healthcheck:
+    get:
+      operationId: healthcheck
+      summary: Health check
+      description: This endpoint is a simple check to see if the server is operating and can respond.
+      tags:
+        - Server
+      responses:
+        200:
+          description: healthcheck OK
+          content: {}