From 871e5ff8df5d84c2093054feb04491936111d351 Mon Sep 17 00:00:00 2001 From: aegis-scribe Date: Mon, 22 Jun 2026 15:31:43 +0200 Subject: [PATCH] docs(api): document recoveryDisabled field on SessionInfo (PR #4802) PR #4803 added a per-session kill-switch for stall auto-recovery (F-4). The new optional boolean field `recoveryDisabled?: boolean` is persisted on SessionInfo and exposed in the GET /v1/sessions/:id response. Document the field semantics for API consumers: - Operator-facing kill-switch for stall auto-recovery - Survives Aegis restarts (persisted on session record) - Only present when explicitly set (defaults to false) - Currently toggled via dashboard stall pill (PR #4804 follow-up); no REST endpoint to set it directly yet Refs: #4802 (F-4) --- docs/api-reference.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api-reference.md b/docs/api-reference.md index 2c6ca680..6c083d14 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -864,12 +864,13 @@ curl http://localhost:9100/v1/sessions/abc123 \ -H "Authorization: Bearer $TOKEN" ``` -**Response:** Session object with `actionHints` for current interactive state, `latestActivityText` for live agent activity, `ccSessionId` when correlated with a Claude Code session, and `telegramTopicId` when a Telegram topic is linked. +**Response:** Session object with `actionHints` for current interactive state, `latestActivityText` for live agent activity, `ccSessionId` when correlated with a Claude Code session, `telegramTopicId` when a Telegram topic is linked, and `recoveryDisabled` when stall auto-recovery is paused on this session. | Field | Type | Description | |-------|------|-------------| | `latestActivityText` | string | Human-readable description of current agent activity (e.g. `"Running: npm test"`, `"Editing: server.ts"`, `"Idle"`, `"Waiting for input"`, `"Compacting context"`). Updated in real-time from CC hook events. | | `ccSessionId` | string | Claude Code session ID correlated with this Aegis session via the `CLAUDE_CODE_SESSION_ID` environment variable. Only present when the CC→Aegis mapping has been established through MCP tool usage. | +| `recoveryDisabled` | boolean | Per-session kill-switch for stall auto-recovery. When `true`, Aegis will not auto-restart a stalled session — the operator has paused recovery. Persists across Aegis restarts. Only present when explicitly set (defaults to `false`). Currently toggled via the dashboard stall pill; no REST endpoint to set it directly. | **Errors:**