chore: add docs for health

docs/api/internal/health.md

@@ -0,0 +1,30 @@
+---
+id: health
+title: /health
+---
+
+# Health API
+
+`GET http://unleash.host.com/health`
+
+Used to check the health of the running Unleash instance. This endpoint has two possible responses:
+
+`Status: 200`
+
+```json
+{
+  "health": "GOOD"
+}
+```
+
+This response means everything is OK. Unleash is able to talk to the PostgreSQL
+
+`Status: 500`
+
+```json
+{
+  "health": "BAD"
+}
+```
+
+This response indicates that Unleash is not able to talk to PostgreSQL and will not be able to serve requests.

website/i18n/en.json

@@ -80,7 +80,10 @@
       "api/index": {
         "title": "API Documentation"
       },
-      "api/internal": {
+      "api/internal/health": {
+        "title": "/health"
+      },
+      "api/internal/internal": {
         "title": "/internal-backstage/prometheus"
       },
       "api/open_api": {
@@ -196,7 +199,7 @@
     },
     "categories": {
       "Getting started": "Getting started",
-      "Working with your SDK": "Working with your SDK",
+      "Working with the SDK": "Working with the SDK",
       "Addons framework": "Addons framework",
       "Advanced": "Advanced",
       "Client": "Client",

website/sidebars.json

@@ -51,7 +51,7 @@
       "api/admin/feature-types",
       "api/admin/addons"
     ],
-    "Internal": ["api/internal"],
+    "Internal": ["api/internal/internal", "api/internal/health"],
     "Specification": ["api/open_api"]
   },
   "Deploy and manage": {