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 a new initiator field in dispute objects. This field specifies who initiated each dispute (buyer, seller, or null). All API documentation and response examples have been updated to reflect this change.

[coderabbitai]

Walkthrough

This change updates the restore_session protocol documentation to include the initiator field in dispute objects. The field indicates who initiated a dispute with possible values of "buyer", "seller", or null across example entries and field definitions.

Changes

Cohort / File(s)	Summary
Documentation Update src/restore_session.md	Added initiator field to disputes objects in restore_session responses with examples showing "seller" values and field documentation describing possible values ("buyer", "seller", or null).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

• #598: Referenced as dependency; both changes add the initiator field to restore_session disputes payload.
• #129: Both changes add initiator field to restored dispute data in restore-session responses.

Possibly related PRs

• protocol#19: Modifies the restore_session response's disputes structure in the same documentation file, adding status field alongside initiator field changes.

Suggested reviewers

• grunch

Poem

🐰 A dispute needs its origin traced,
Who sparked the flame, let's embrace it!
Buyer or seller, now we'll know,
The initiator's gentle glow.
Documentation blooms anew! 🌱

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: documenting the initiator field in restore data, which aligns with the file changes in restore_session.md.
Linked Issues check	✅ Passed	The PR fully addresses issue #28 by documenting the initiator field in disputes objects of restore_session.md with values and examples.
Out of Scope Changes check	✅ Passed	All changes are directly related to issue #28; the modifications only add documentation of the initiator field to restore_session.md with no unrelated changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• 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

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