Skip to main content

Module rest

Module rest 

Source

Structs§

BearerAuthLayer
[tower_layer::Layer] that wraps a router (or any inner tower service) with bearer-token auth.
BearerAuthService
The [tower_service::Service] produced by BearerAuthLayer.
CodexRestBackend
Production REST backend.
RestCallBody
Request body for raw method bridge calls.
RestCallRequest
Backend-facing raw method call request.
RestCallResponse
Response body for raw method bridge calls.
RestClientOptions
Optional client/session overrides for REST requests that spawn Codex.
RestErrorReplyRequest
Request body for replying with an error to a server-originated request.
RestErrorResponse
Structured REST error payload.
RestHealthResponse
Health response returned by GET /health and GET /v1/health.
RestLimits
Resource limits used by the default REST backend and route layer.
RestLimitsEnvError
Error returned by RestLimits::try_from_env when a CODEX_APP_SERVER_REST_* environment variable is set but cannot be parsed as its expected type.
RestListSessionsResponse
Response body for GET /v1/sessions.
RestRequestReplyResponse
Response body for request-reply endpoints.
RestRequestReplyResultRequest
Request body for replying successfully to a server-originated request.
RestRouterOptions
REST router behavior knobs.
RestSessionCreateRequest
Request body for POST /v1/sessions.
RestSessionCreateResponse
Response body for POST /v1/sessions.
RestSessionSummary
One session entry in GET /v1/sessions.
RestStatusResponse
Simple status response used by mutating bridge endpoints.
RestTextTurnRequest
Request body for POST /v1/text-turn.
RestTextTurnResponse
Response body for POST /v1/text-turn.

Enums§

RestApprovalPolicy
REST approval policy preset used while collecting turn events.
RestError
Errors surfaced by the optional REST adapter.
RestEventResponse
Event returned by GET /v1/sessions/{sessionId}/events.

Traits§

RestBackend
Backend used by the REST router.

Functions§

bearer_auth
Builds a BearerAuthLayer that requires Authorization: Bearer <token> on every request except (by default) the health routes.
openapi_spec
Builds the full OpenAPI 3.1.0 document for the rest module.
router
Builds a conservative REST router backed by real codex app-server processes.
router_with_backend
Builds a REST router with a caller-provided backend.
router_with_backend_and_options
Builds a REST router with a caller-provided backend and options.
router_with_backend_arc
Builds a REST router from a shared backend trait object.
router_with_backend_arc_and_options
Builds a REST router from a shared backend trait object and options.
router_with_options
Builds a REST router backed by real codex app-server processes and options.
text_turn_router
Builds a router with the one-shot text-turn helper enabled.
trusted_bridge_router
Builds a trusted full bridge router backed by real codex app-server processes.

Type Aliases§

RestFuture
RestResult