Documents initiator field in restore data

[BraCR10]

Closes #28
Depends on: MostroP2P/mostro#598

Summary by CodeRabbit

• New Features

  • The restore_session API response now includes an initiator field on dispute objects indicating who opened the dispute ("buyer", "seller", or null).

• Documentation

  • API docs and example payloads updated to show the new initiator field for disputes.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 234851d4-3ca4-4719-aedf-797fc349f1b6

📥 Commits

Reviewing files that changed from the base of the PR and between 219544c and 5237ab0.

📒 Files selected for processing (1)

• src/restore_session.md

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

• src/restore_session.md

---

Walkthrough

Adds an initiator field to dispute objects in src/restore_session.md documentation and example payloads; initiator can be "buyer", "seller", or null.

Changes

Cohort / File(s)	Summary
Documentation src/restore_session.md	Documented and added initiator to dispute objects in descriptions and all example payloads (values: "buyer", "seller", or null).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• chore: updated restore message #19 — Related changes to restore_session payload structure and disputes documentation.

Suggested reviewers

• grunch

Poem

🐰 I nibble through lines with carrot-cheer,
A tiny field now whispers clear;
Who sparked the quarrel? see it near —
Buyer, seller, or none appear. 🥕

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: documenting the initiator field in restore data, which matches the file updates and objectives.
Linked Issues check	✅ Passed	The changes fully satisfy issue #28 by updating restore_session.md to document the initiator field in disputes with proper descriptions and examples.
Out of Scope Changes check	✅ Passed	All changes are directly related to documenting the initiator field in restore_session.md, with no unrelated modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

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

📝 Coding Plan

• Generate coding plan for human review comments

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.

Add a .trivyignore file to your project to customize which findings Trivy reports.

[arkanoider]

ACK!

Exactly what the new message is sending!

[grunch]

hi @BraCR10 can you please fix conflicts?

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/restore_session.md`:
- Around line 71-72: The spec mixes `id` and `order_id` for restore_data.orders
entries; pick one canonical field (prefer `id` per the schema text) and make all
places consistent: update the schema line describing `restore_data.orders` and
every example and description that currently uses `order_id` to use `id` instead
(and do the same for `restore_data.disputes` references if they use `order_id`),
and run a quick grep for `order_id` in this doc to replace remaining occurrences
so clients see a single field name (`restore_data.orders[].id` and
`restore_data.disputes[].order_id` only if disputes keep a distinct field) and
update any explanatory text that references the old name.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 03867a50-7283-4d6f-8593-9e73c4e1eba1

📥 Commits

Reviewing files that changed from the base of the PR and between 68b0d60 and 219544c.

📒 Files selected for processing (1)

• src/restore_session.md

[Catrya]

tACK