sessions update

[ChristopherTrimboli]

📚 Sessions API Documentation Update

This PR comprehensively updates the documentation to reflect all the new Sessions API features and improvements from the latest codebase changes.

🎯 Overview

The Sessions API has been significantly enhanced with advanced timeout management, automatic renewal capabilities, and improved error handling. This documentation update ensures all these features are properly documented for developers.

📄 New Documentation Files Created

API Reference Pages

• docs/api-reference/messaging/renew-session.mdx - Manual session renewal endpoint
• docs/api-reference/messaging/update-session-timeout.mdx - Timeout configuration update endpoint
• docs/api-reference/messaging/session-heartbeat.mdx - Heartbeat endpoint for keeping sessions alive
• docs/api-reference/messaging/list-sessions.mdx - Admin endpoint to list all active sessions
• docs/api-reference/messaging/sessions-api-reference.mdx - Comprehensive API reference with all endpoints, examples, and SDK code

Architecture & Guides

• docs/deep-dive/sessions-architecture.mdx - Deep dive into Sessions API architecture, design patterns, and implementation details
• docs/guides/sessions-api-guide.mdx - Complete guide with best practices, patterns, and real-world examples

📝 Updated Documentation Files

Enhanced API References

• docs/api-reference/messaging/create-session.mdx

  • Added timeout configuration parameters
  • Documented hierarchical config system
  • Added auto-renewal and max duration settings

• docs/api-reference/messaging/send-session-message.mdx

  • Added session renewal tracking in response
  • Documented automatic activity updates
  • Added warning state information

• docs/api-reference/messaging/get-session-messages.mdx

  • Enhanced with cursor-based pagination docs
  • Added bidirectional pagination examples
  • Documented range queries

• docs/api-reference/messaging/get-session.mdx

  • Added real-time status fields (timeRemaining, isNearExpiration)
  • Documented renewal count tracking
  • Added comprehensive error responses

• docs/api-reference/messaging/end-session.mdx

  • Clarified channel preservation behavior
  • Added important notes about data retention

• docs/api-reference/messaging/sessions-health-check.mdx

  • Added new metrics (expiringSoon, invalidSessions, uptime)
  • Enhanced health status definitions

OpenAPI Specification

• docs/api-reference/openapi.yaml
  • Added all new endpoints (renew, heartbeat, timeout update, list)
  • Updated existing endpoints with new fields
  • Added SessionInfo schema component
  • Enhanced error responses with 410 Gone status
  • Added pagination cursor support

Navigation

• docs/docs.json
  • Added Sessions API grouped section in messaging
  • Added deep-dive sessions architecture page
  • Improved navigation hierarchy

✨ Key Features Documented

1. Timeout Management

• Hierarchical configuration (session → agent → global)
• Dynamic timeout updates during active sessions
• Configurable min/max boundaries
• Warning thresholds for expiration alerts

2. Session Renewal

• Automatic renewal on activity
• Manual renewal endpoint
• Maximum duration limits
• Renewal count tracking
• Heartbeat mechanism

3. Error Handling

• 13 specific error classes documented
• Consistent error response format
• Proper HTTP status codes (410 for expired sessions)
• Detailed error context and debugging info

4. Advanced Patterns

• Resilient client implementation with retry logic
• Session recovery patterns
• Cursor-based pagination for message history
• WebSocket integration for real-time updates
• SDK examples in TypeScript and Python

5. Configuration

• 7 environment variables for fine-tuning
• Agent-specific timeout settings
• Session-level configuration overrides
• Cleanup interval management

📊 Documentation Coverage

Area	Files Added	Files Updated	Total
API Reference	5	6	11
Guides	1	0	1
Architecture	1	0	1
OpenAPI Spec	0	1	1
Navigation	0	1	1
Total	7	8	15

🔍 Technical Improvements

1. Comprehensive Examples: Added SDK implementations in TypeScript and Python
2. Real-world Patterns: Documented production-ready patterns for session management
3. Error Recovery: Detailed error handling and recovery strategies
4. Performance: Pagination optimization and cleanup strategies
5. Monitoring: Health check enhancements for better observability

📌 Important Changes

• Sessions now support hierarchical timeout configuration with proper precedence
• 410 Gone status code properly indicates expired sessions
• Cursor-based pagination replaces simple offset pagination for better performance
• Session renewal can be controlled at multiple levels (global, agent, session)
• Warning states help prevent unexpected session expiration

🧪 Testing the Documentation

All code examples have been validated against the actual implementation. The OpenAPI specification has been updated to match the current API surface.

🚀 Migration Notes

For users of the previous Sessions API:

• The basic API remains backward compatible
• New optional parameters enhance functionality without breaking changes
• Consider implementing heartbeat for long-running sessions
• Update error handling to handle new error codes

📚 Related Documentation

The updated documentation integrates well with:

• WebSocket integration guide for real-time features
• Core concepts for understanding agent architecture
• Plugin development guide for extending functionality

---

This documentation update ensures developers have comprehensive, accurate, and practical information for implementing the enhanced Sessions API in their applications.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch sessions-update

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[claude]

Claude encountered an error —— View job

---

I'll analyze this and get back to you.

[claude]

Claude encountered an error —— View job

---

I'll analyze this and get back to you.

[claude]

Claude encountered an error —— View job

---

I'll analyze this and get back to you.