docs(sessions): add endpoint to mark chat as read
Closed
AH
5mo ago+97+97+01234567890123456789-1-1-0123456789
- Introduced a new POST endpoint
/api/sessions/{sessionId}/chats/{chatId}/readto mark a session chat as read. This endpoint updates thelastReadAttimestamp for the specified chat and ensures idempotency. - Updated the OpenAPI specification with detailed request parameters and response schemas, including success and error responses.
- Enhanced the documentation to include the new endpoint in the API reference, improving clarity for users managing session chats.
Summary by cubic
Documented a new POST endpoint to mark a session chat as read and updated the OpenAPI spec and API reference. This lets clients clear unread state (hasUnread becomes false) for a chat until new assistant activity arrives.
- New Features
- Added
POST /api/sessions/{sessionId}/chats/{chatId}/readto upsert a read receipt and setlastReadAt. Idempotent. - OpenAPI: path params
sessionIdandchatId.200returnsMarkChatReadResponse { success: true }. Added401,403,404,500errors. - Docs: new API page and nav entry under Sessions.
- Added
Summary by CodeRabbit
-
New Features
- Added a new
POST /api/sessions/{sessionId}/chats/{chatId}/readendpoint with idempotent behavior and comprehensive error handling.
- Added a new
-
Documentation
- Added documentation page for the new endpoint.
- Updated API reference navigation to include the new resource.