Skip to content

docs: add missing docs for global config endpoints #25166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abzy128 wants to merge 1 commit into
base: dev
Choose a base branch
from
+8 −6
Open

docs: add missing docs for global config endpoints #25166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions packages/web/src/content/docs/server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,12 @@ The opencode server exposes the following APIs.

### Global

| 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 |
| 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 |
| `GET` | `/global/config` | Get global config info | <a href={typesUrl}><code>Config</code></a> |
| `PATCH` | `/global/config` | Update global config | <a href={typesUrl}><code>Config</code></a> |

---

Expand Down Expand Up @@ -126,8 +128,8 @@ The opencode server exposes the following APIs.

| Method | Path | Description | Response |
| ------- | ------------------- | --------------------------------- | ---------------------------------------------------------------------------------------- |
| `GET` | `/config` | Get config info | <a href={typesUrl}><code>Config</code></a> |
| `PATCH` | `/config` | Update config | <a href={typesUrl}><code>Config</code></a> |
| `GET` | `/config` | Get instance config info | <a href={typesUrl}><code>Config</code></a> |
| `PATCH` | `/config` | Update instance config | <a href={typesUrl}><code>Config</code></a> |
| `GET` | `/config/providers` | List providers and default models | `{ providers: `<a href={typesUrl}>Provider[]</a>`, default: { [key: string]: string } }` |

---
Expand Down
Loading