Skip to main content

Module openapi

Module openapi 

Source
Expand description

GET /api/v1/openapi.json: the whole HTTP surface as one OpenAPI 3.1 document, generated from what serves it:

  • the REST tools, from the tool registry (one POST per tool the listener offers);
  • the workspace resource, from WORKSPACE_ROUTES (the table its router dispatches by) with each tool’s schema as the body;
  • the identity endpoints, from crate::auth::http::spec::ROUTES (held to their router by a test);
  • the streams, websockets, webhooks, logos, MCP and health, from SURFACE.

Operations carry x-isb-tool (the MCP tool that does the same) or x-isb-browser-only (why there is none), which docs/reference/parity.md and the web UI’s parity test read.

Structs§

Surface
One route outside the tools and the identity endpoints.

Enums§

Agents
Where the same capability is for agents.

Constants§

SURFACE
The streams, websockets and the rest: the routes [super::mcp::Endpoint] and the daemon’s own routes answer besides the tools and identity.
WORKSPACE_ROUTES
The workspace resource (/orgs/<org>/api/v1/workspace[ACTION]): (action, method, tool). The router dispatches by this table.

Functions§

document
The document, for the tools a listener offers.
workspace_tool
The workspace tool for action and method: Ok(tool), or Err(allowed methods) (empty: no such action).