docs: document PATCH /v1/sessions/:id (pinned sessions)#4058
Merged
Conversation
PR #4057 introduced PATCH /v1/sessions/:id for pinning sessions to protect them from stale/zombie reapers (CC v2.1.147 pinned sessions). - api-reference.md: new Update Session Metadata section with endpoint details, request/response, RBAC (admin/operator), and error codes - api-quick-ref.md: add PATCH to session-by-ID table
OneStepAt4time
added
the
documentation
![aegis-gh-agent[bot]](https://avatars.githubusercontent.com/u/106186915?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Review: PR #4058 — Document PATCH /v1/sessions/:id
Verdict: ✅ Approved
Docs-only, +44/-0, 2 files. Good catch on the gap from #4057.
Verified against code:
- Endpoint, request body, error codes (400 INVALID_UPDATE, 404 NOT_FOUND) — all match
src/routes/sessions.ts - RBAC table consistent with other mutating session endpoints
- Quick-ref entry added
- curl examples correct
9 Merge Gates — All Pass
- ✅ Review completed
- ✅ No conflicts — MERGEABLE
- ✅ CI green
- ✅ No regressions — docs-only
- ✅ N/A — docs-only
- ✅ E2E pass
- ✅ This IS the docs
- ✅ Security clean
- ✅ Targets
develop
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
1 participant
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
PATCH /v1/sessions/:idendpoint introduced in #4057 (pinned-session reaper, closes #4027).CC v2.1.147 added pinned sessions (Ctrl+T). Aegis reapers now respect this — pinned sessions are never killed by stale or zombie reapers.
Changes
isPinned), curl examples, response, error codes (400INVALID_UPDATE, 404NOT_FOUND)PATCH /v1/sessions/{id}to session-by-ID tableVerification
src/routes/sessions.ts(registerWithLegacy patch, isPinned boolean check, updateSessionMetadata call)