Switch to JSON for health checks (#3)

Switch to JSON for health checks to unify all endpoints on JSON Signed-off-by: Matthew <[email protected]>
SidingsMedia · Apr 29, 2024 · abb03f4 · abb03f4
1 parent be244ca
commit abb03f4
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 17 deletions.
diff --git a/components/responses/HealthCheckFail.yaml b/components/responses/HealthCheckFail.yaml
diff --git a/components/responses/HealthCheckOK.yaml b/components/responses/HealthCheckOK.yaml
@@ -1,10 +1,11 @@
 # SPDX-FileCopyrightText: 2024 Sidings Media
 # SPDX-License-Identifier: MIT
 
-description: Service is healthy
+description: Health Check is OK
 content:
-  text/plain:
+  application/json:
     schema:
-      type: string
+      $ref: ../schemas/GeneralError.yaml
     example:
-      healthy
+      code: 200
+      message: OK
diff --git a/paths/messaging/health.yaml b/paths/messaging/health.yaml
@@ -13,4 +13,4 @@ get:
     '429':
       $ref: ../../components/responses/TooManyRequests.yaml
     5XX:
-      $ref: ../../components/responses/HealthCheckFail.yaml
+      $ref: ../../components/responses/ServerError.yaml
diff --git a/paths/openapi/health.yaml b/paths/openapi/health.yaml
@@ -13,4 +13,4 @@ get:
     '429':
       $ref: ../../components/responses/TooManyRequests.yaml
     5XX:
-      $ref: ../../components/responses/HealthCheckFail.yaml
+      $ref: ../../components/responses/ServerError.yaml
diff --git a/paths/static/health.yaml b/paths/static/health.yaml
@@ -13,4 +13,4 @@ get:
     '429':
       $ref: ../../components/responses/TooManyRequests.yaml
     5XX:
-      $ref: ../../components/responses/HealthCheckFail.yaml
+      $ref: ../../components/responses/ServerError.yaml