diff options
| author | opencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com> | 2025-12-22 22:26:47 -0600 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-12-22 22:26:47 -0600 |
| commit | 968543af398da3274014f74354de5f56141447ef (patch) | |
| tree | fc0c12b7f95e6f2ef57b7bdfffe0957eae396252 | |
| parent | 5af35117db705b71604cc3e6a4ed07fc9bbf28e7 (diff) | |
| download | opencode-968543af398da3274014f74354de5f56141447ef.tar.gz opencode-968543af398da3274014f74354de5f56141447ef.zip | |
docs: new `/global/health` API (#6006)
Co-authored-by: opencode-agent[bot] <opencode-agent[bot]@users.noreply.github.com>
| -rw-r--r-- | packages/web/src/content/docs/sdk.mdx | 17 | ||||
| -rw-r--r-- | packages/web/src/content/docs/server.mdx | 9 |
2 files changed, 22 insertions, 4 deletions
diff --git a/packages/web/src/content/docs/sdk.mdx b/packages/web/src/content/docs/sdk.mdx index 4f9a2959f..1ff843103 100644 --- a/packages/web/src/content/docs/sdk.mdx +++ b/packages/web/src/content/docs/sdk.mdx @@ -123,6 +123,23 @@ The SDK exposes all server APIs through a type-safe client. --- +### Global + +| Method | Description | Response | +| ----------------- | ------------------------------- | ------------------------------------ | +| `global.health()` | Check server health and version | `{ healthy: true, version: string }` | + +--- + +#### Examples + +```javascript +const health = await client.global.health() +console.log(health.data.version) +``` + +--- + ### App | Method | Description | Response | diff --git a/packages/web/src/content/docs/server.mdx b/packages/web/src/content/docs/server.mdx index 60aff2003..427d8f505 100644 --- a/packages/web/src/content/docs/server.mdx +++ b/packages/web/src/content/docs/server.mdx @@ -68,11 +68,12 @@ The opencode server exposes the following APIs. --- -### Global Events +### Global -| Method | Path | Description | Response | -| ------ | --------------- | ------------------------------ | ------------ | -| `GET` | `/global/event` | Get global events (SSE stream) | Event stream | +| Method | Path | Description | Response | +| ------ | ---------------- | ------------------------------ | ------------------------------------ | +| `GET` | `/global/health` | Get server health and version | `{ healthy: true, version: string }` | +| `GET` | `/global/event` | Get global events (SSE stream) | Event stream | --- |