chore: updated restore message

[arkanoider]

@grunch

updated protocol

Summary by CodeRabbit

• Documentation
  • Updated restore-session API docs to reflect revised request and response payloads.
  • Requests now send a restore_request payload instead of null.
  • Responses now wrap returned data under a restore_data object, with orders and disputes nested inside.
  • Examples and descriptive text updated to match the new structure.
  • Disputes field description clarified to indicate inclusion of each dispute's current status.

[coderabbitai]

Walkthrough

Response documentation for the restore-session message was updated: the response payload now nests previous top-level orders and disputes inside payload.restore_data. Examples and field descriptions were revised; no public API or code declarations changed.

Changes

Cohort / File(s)	Summary
Docs: restore-session src/restore_session.md	Response payload refactored so orders and disputes are nested under payload.restore_data. Updated disputes field description to note inclusion of dispute status. Example JSON and example use-case text updated. No changes to exported/public declarations.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant Server

  Client->>Server: restore-session request { payload: "restore_request" }
  Server-->>Client: restore-session response { payload: { restore_data: { orders, disputes } } }

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

• grunch

Poem

I nibble at schemas, tidy every byte,
Wrapped orders and disputes safe through the night.
Restore_data cradles each little row,
Docs neat and ready — hop, off I go. 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 9476591 and e64b5b1.

📒 Files selected for processing (1)

• src/restore_session.md (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/restore_session.md

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

src/restore_session.md (1)

14-14: Clarify the request payload sentinel and backward compatibility.

Switching the request payload to the string literal "restore_request" is a behavioral change. Please confirm this is intentional and document that clients must send the literal string (not an object), plus note server behavior if older clients still send null.

Would you like me to add a short compatibility note under the Request section?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 3e16525 and 44c9e7c.

📒 Files selected for processing (1)

• src/restore_session.md (3 hunks)

🔇 Additional comments (1)

src/restore_session.md (1)

26-28: Confirm whether the protocol version should be bumped.

The response schema changed (orders/disputes moved under payload.restore_data), which is potentially breaking. Verify if version: 1 remains correct or should be incremented.

If you confirm a version bump is needed, I can update the examples and headings accordingly.

[grunch]

LGTM