[PR #5136] docs: update server API reference with complete endpoint list #11262

Closed
opened 2026-02-16 18:16:04 -05:00 by yindo · 0 comments
Owner

Original Pull Request: https://github.com/anomalyco/opencode/pull/5136

State: closed
Merged: Yes


Summary

Updates the server API documentation (/docs/server) to reflect the complete current API surface as of the latest dev branch.

Changes

  • Added missing endpoint sections:

    • Global Events (/global/event)
    • Project (/project, /project/current)
    • Path & VCS (/path, /vcs)
    • Instance (/instance/dispose)
    • Provider OAuth (/provider, /provider/auth, /provider/{id}/oauth/*)
  • Added missing session endpoints:

    • /session/status - Get status for all sessions
    • /session/{id}/fork - Fork a session at a message
    • /session/{id}/todo - Get todo list for a session
  • Added missing message endpoints:

    • /session/{id}/prompt_async - Send message asynchronously (non-blocking)
    • /session/{id}/command - Execute slash commands
  • Added experimental tool endpoints:

    • /experimental/tool/ids - List all tool IDs
    • /experimental/tool - List tools with schemas
  • Added service status endpoints:

    • /lsp - LSP server status
    • /formatter - Formatter status
    • /mcp - MCP server status
  • Added /command endpoint for listing slash commands

  • Reorganized documentation into logical groups for better navigation

Generation Method

Documentation was generated from the latest OpenAPI spec using opencode generate command and manually formatted to match the existing docs style.

Context

Fulfills promise made in https://github.com/sst/opencode/issues/3487#issuecomment-3575646390 to update the docs with the latest API spec.

**Original Pull Request:** https://github.com/anomalyco/opencode/pull/5136 **State:** closed **Merged:** Yes --- ## Summary Updates the server API documentation (`/docs/server`) to reflect the complete current API surface as of the latest `dev` branch. ## Changes - **Added missing endpoint sections:** - Global Events (`/global/event`) - Project (`/project`, `/project/current`) - Path & VCS (`/path`, `/vcs`) - Instance (`/instance/dispose`) - Provider OAuth (`/provider`, `/provider/auth`, `/provider/{id}/oauth/*`) - **Added missing session endpoints:** - `/session/status` - Get status for all sessions - `/session/{id}/fork` - Fork a session at a message - `/session/{id}/todo` - Get todo list for a session - **Added missing message endpoints:** - `/session/{id}/prompt_async` - Send message asynchronously (non-blocking) - `/session/{id}/command` - Execute slash commands - **Added experimental tool endpoints:** - `/experimental/tool/ids` - List all tool IDs - `/experimental/tool` - List tools with schemas - **Added service status endpoints:** - `/lsp` - LSP server status - `/formatter` - Formatter status - `/mcp` - MCP server status - **Added `/command` endpoint** for listing slash commands - **Reorganized documentation** into logical groups for better navigation ## Generation Method Documentation was generated from the latest OpenAPI spec using `opencode generate` command and manually formatted to match the existing docs style. ## Context Fulfills promise made in https://github.com/sst/opencode/issues/3487#issuecomment-3575646390 to update the docs with the latest API spec.
yindo added the pull-request label 2026-02-16 18:16:04 -05:00
yindo closed this issue 2026-02-16 18:16:04 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#11262