Modified wrapper name of the message#18
Conversation
WalkthroughRenamed the top-level JSON envelope key from "order" to "restore" in three examples within Restore Session documentation: client request, server response, and example use case. Internal fields (version, action, payload) and payload contents remain unchanged. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
src/restore_session.md (2)
76-91: Inconsistent example: order status "dispute" conflicts with documented statuses and duplicates the dispute entry.Earlier text enumerates order statuses (pending, active, fiat-sent, waiting-buyer-invoice, waiting-payment, settled-hold-invoice). "dispute" is not listed there; plus the same trade_index=4 appears in both orders and disputes arrays. Either remove the order entry for the disputed trade from the orders list or use a valid order status and avoid duplication. Recommend removal for clarity.
Apply this diff to fix the example JSON:
- { "id": "ghi-789", "trade_index": 3, "status": "active" }, - { "id": "xyz-999", "trade_index": 4, "status": "dispute" } + { "id": "ghi-789", "trade_index": 3, "status": "active" }
11-16: Add deprecation note for the old “order” wrapper in restore-sessionAll examples now use the
"restore"key; no remaining docs reference"order"forrestore-session. To avoid client confusion, please insert a brief compatibility note insrc/restore_session.mdright after the request example.• File:
src/restore_session.md(after line 16)
• Suggested one-liner:> Note: The previous wrapper key `order` has been deprecated for `restore-session` requests in favor of `restore`.
🧹 Nitpick comments (2)
src/restore_session.md (2)
25-56: Consistent wrapper key in Response; consider documenting allowed top-level wrappers.The rename is consistently applied in the response block. To reduce ambiguity across commands, add a short note or link listing all valid top-level envelope keys (e.g., order, restore, etc.) and their intended scopes.
7-7: Minor wording nit: “rumor’s content” → “Rumor content”.To align with Nostr terminology and improve readability, suggest: “...with the following Rumor content:”
Changed wrapper of new command to
restoreSummary by CodeRabbit