docs: add terminal session states (killed, completed, crashed)#3145
Merged
Conversation
- 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
fa73622 to
029ea64
Compare
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new terminal session states added by PR #3140.
Changes
docs/api-reference.md:killed,completed,crashedDELETE /v1/sessions/:id): updated description — session is now marked askilled(not deleted), retained for auditREADME.md:killed,completed,crashedas terminal statesstalled(not a validUIStatevalue)rate_limitfor completenessContext
UIStateand changedkillSession()to mark askilledinstead of deletingstalledwas listed in README but was never a validUIStatevalueVerification
src/api-contracts.ts—UIStatenow includes all 17 valuessrc/routes/session-actions.ts— kill handler rejects terminal states with 404src/session.ts—killSession()setsstatus = "killed"instead of deleting