Conversation
Correct scopes, device registration fields and response, negotiate request/response shapes, and session completion payload. Document the save upload/download/confirm endpoints and list RomM Desktop as a reference client. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013q3PdG4Zfn6QWeBCRnC1sm
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013q3PdG4Zfn6QWeBCRnC1sm
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/developers/device-sync-protocol.mddidn't match what the RomM server implements. A client built from the old page would fail against a real server. This PR rewrites the page to match the backend (backend/endpoints/device.py,backend/endpoints/sync/,backend/endpoints/saves.py,backend/endpoints/play_sessions.pyand their response schemas).Changes
POST /api/play-sessionsneedsroms.user.write, notme.*.mac_address,client,client_version,sync_config,allow_existing,allow_duplicate,reset_syncs, with nopaths). The realsync_modevalues (api,file_transfer,push_pull). How idempotent matching works, and the{ device_id, name, created_at }response with a string UUIDdevice_id.saves[]+rom_idsrequest with an MD5content_hash, pairing on(rom_id, slot), and the error codes (400/404). The response uses an integersession_id,actioninstead oftype,no_op,save_id, and thetotal_*counts. Removes thedestination/source/dest_path/resolutionfields, which don't exist.overwrite/autocleanupand the 409 guard,PUTupdate, download withoptimistic, and the/downloadedconfirmation.start_time/end_time/duration_ms/save_slot, the response shape, and the standalone/api/play-sessionsalternative.Frontmatter, title and "See also" links are kept. The page passes prettier and markdownlint with the repo's Trunk configs.
AI disclosure
This change was written with AI assistance (Claude Code), working from a comparison of the page against the RomM server source. Please review it against the backend before merging.
🤖 Generated with Claude Code
https://claude.ai/code/session_013q3PdG4Zfn6QWeBCRnC1sm