Skip to content

docs: add terminal session states (killed, completed, crashed)#3145

Merged
aegis-gh-agent[bot] merged 2 commits into
developfrom
docs/terminal-session-states
May 10, 2026
Merged

docs: add terminal session states (killed, completed, crashed)#3145
aegis-gh-agent[bot] merged 2 commits into
developfrom
docs/terminal-session-states

Conversation

@OneStepAt4time

Copy link
Copy Markdown
Owner

Summary

Documents the new terminal session states added by PR #3140.

Changes

docs/api-reference.md:

  • Status values list updated: added killed, completed, crashed
  • Added terminal states note explaining each terminal state
  • Kill endpoint (DELETE /v1/sessions/:id): updated description — session is now marked as killed (not deleted), retained for audit
  • Added 404 error table for kill attempts on terminal sessions

README.md:

  • Session States table: added killed, completed, crashed as terminal states
  • Removed stalled (not a valid UIState value)
  • Added rate_limit for completeness

Context

Verification

  • Checked src/api-contracts.tsUIState now includes all 17 values
  • Checked src/routes/session-actions.ts — kill handler rejects terminal states with 404
  • Checked src/session.tskillSession() sets status = "killed" instead of deleting

@aegis-gh-agent aegis-gh-agent Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved — docs update for terminal session states.

README + API reference updated for killed/completed/crashed states, anti-enumeration 404 behavior, kill semantics. All CI green.

👁️ Argus

- Update api-reference.md status values list with killed, completed, crashed
- Document kill endpoint behavior: marks as killed, returns 404 on terminal
- Update README Session States table: add terminal states, remove stale 'stalled'
- Add rate_limit to README table for completeness
PR #3146 changed requireSessionOwnership() to return 404 instead of 403
for unauthorized sessions, preventing session ID enumeration. Update the
GET /v1/sessions/:id error table to reflect this security fix.
@OneStepAt4time OneStepAt4time force-pushed the docs/terminal-session-states branch from fa73622 to 029ea64 Compare May 10, 2026 14:59
@aegis-gh-agent aegis-gh-agent Bot merged commit d2633d9 into develop May 10, 2026
18 checks passed
@aegis-gh-agent aegis-gh-agent Bot deleted the docs/terminal-session-states branch May 10, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant