@oasisomniverse/web5-api 1.0.0

package/docs/modules/Health.md

@@ -0,0 +1,90 @@
+# Health — `star.health`
+
+Source controller: [`HealthController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/HealthController.cs)
+Route prefix: `api/health`
+2 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `get`
+
+Health check endpoint for Railway deployment
+
+**GET** `api/health`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `object`
+
+**Example**
+
+```js
+const { isError, message, result } = await star.health.get({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": {}
+}
+```
+
+---
+
+### `health`
+
+Health check endpoint for Railway deployment
+
+**GET** `api/health/health`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `object`
+
+**Example**
+
+```js
+const { isError, message, result } = await star.health.health({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": {}
+}
+```
+