Merge pull request #1 from SidingsMedia/computroniks/features/remove-…

…stats-and-add-healthchecks

Computroniks/features/remove stats and add healthchecks

components/responses/HealthCheckFail.yaml

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2024 Sidings Media
+# SPDX-License-Identifier: MIT
+
+description: Service is unhealthy
+content:
+  text/plain:
+    schema:
+      type: string
+    example:
+      unhealthy

components/responses/HealthCheckOK.yaml

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2024 Sidings Media
+# SPDX-License-Identifier: MIT
+
+description: Service is healthy
+content:
+  text/plain:
+    schema:
+      type: string
+    example:
+      healthy

conf/conf.d/default.conf

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Sidings Media
+# SPDX-FileCopyrightText: 2023-2024 Sidings Media
 # SPDX-License-Identifier: CC0-1.0
 
 server {
@@ -16,12 +16,7 @@ server {
         alias /usr/share/nginx/html/openapi.json;
     }
 
-    location = /docs {
-        default_type "text/html";
-        alias /usr/share/nginx/html/openapi.html;
-    }
-
-    location /health {
+    location /openapi/health {
         return 200 "healthy\n";
         default_type "text/plain";
     }

openapi.yaml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Sidings Media
+# SPDX-FileCopyrightText: 2023-2024 Sidings Media
 # SPDX-License-Identifier: MIT
 
 openapi: 3.0.3
@@ -26,12 +26,12 @@ info:
     | Path Base | Service Name | Repository |
     |---|---|---|
     | `/messaging` | `messaging` | https://github.com/SidingsMedia/messaging.git |
-    | `/stats` | `stats` | https://github.com/SidingsMedia/stats.git |
     | `/terms` | `static` | https://github.com/SidingsMedia/static.git |
+    | `/openapi` | `openapi` | https://github.com/SidingsMedia/openapi.git |
     | `/openapi.json` | `openapi` | https://github.com/SidingsMedia/openapi.git |
     
     Each service will expose a health check endpoint that will return a
-    plaintext `200 OK` response when called. This is documented by the
+    plaintext `200 OK` response when called. This is documented by this
     specification.
     
     ## Operation
@@ -53,7 +53,7 @@ info:
     that do implement a rate limit, you will receive a http `429`
     response with the `retry-after` header set indicating after how many
     seconds you should restart making requests. 
-  version: 0.2.1
+  version: 0.3.0
 
 servers:
   - url: https://api.sidingsmedia.com/
@@ -74,9 +74,14 @@ tags:
 paths:
   /messaging/contact:
     $ref: paths/messaging/contact.yaml
-
-  /stats/views:
-    $ref: paths/stats/views.yaml
+  /messaging/health:
+    $ref: paths/messaging/health.yaml
+
+  /openapi/health:
+    $ref: paths/openapi/health.yaml
+
+  /static/health:
+    $ref: paths/static/health.yaml
 
   /terms:
     $ref: paths/terms.yaml

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "API documentation for the Sidings Media API",
   "main": "index.js",
   "scripts": {

paths/messaging/health.yaml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2024 Sidings Media
+# SPDX-License-Identifier: MIT
+
+get:
+  description: Messaging service health check
+  summary: Health check
+  tags:
+    - messaging
+  responses:
+    '200':
+      $ref: ../../components/responses/HealthCheckOK.yaml
+    '429':
+      $ref: ../../components/responses/TooManyRequests.yaml
+    5XX:
+      $ref: ../../components/responses/HealthCheckFail.yaml

paths/openapi/health.yaml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2024 Sidings Media
+# SPDX-License-Identifier: MIT
+
+get:
+  description: Static service health check
+  summary: Health check
+  tags:
+    - static
+  responses:
+    '200':
+      $ref: ../../components/responses/HealthCheckOK.yaml
+    '429':
+      $ref: ../../components/responses/TooManyRequests.yaml
+    5XX:
+      $ref: ../../components/responses/HealthCheckFail.yaml

paths/static/health.yaml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2024 Sidings Media
+# SPDX-License-Identifier: MIT
+
+get:
+  description: OpenAPI service health check
+  summary: Health check
+  tags:
+    - openapi
+  responses:
+    '200':
+      $ref: ../../components/responses/HealthCheckOK.yaml
+    '429':
+      $ref: ../../components/responses/TooManyRequests.yaml
+    5XX:
+      $ref: ../../components/responses/HealthCheckFail.yaml

paths/terms.yaml

@@ -5,7 +5,7 @@ get:
   description: API terms of use
   summary: Get API terms of use
   tags:
-    - docs
+    - static
   responses:
     '200':
       description: Terms