Start sync with POST (MusicServer 5.0 breaking change) #1

Closed
opened 2026-10-06 16:11:37 +02:00 by Sansan · 1 comment
Owner

Breaking change in MusicServer 5.0: sync endpoints are POST only. Fix this before (or together with) deploying the new server, or the sync button stops working.

What changed on the server

These endpoints changed from GET to POST, on both legacy routes and /api/v1:

  • /sync, /sync/new, /sync/quick (sync only changes)
  • /sync/full, /sync/new/full (full sync)
  • /sync/reset (deletes all soundtracks and songs)

A GET on these paths now returns 404 and does nothing. GET /sync/progress is unchanged. Starting a sync while one is running returns 423 Locked.

Change in MusicFrontend

src/components/items/extraButtons.vue, APIsyncSoundtracks():

this.axios({
    method: "post",
    url: `${window.__RUNTIME_CONFIG__.API_HOSTNAME}/sync`,
})

Also handle 423 (a sync is already running), for example by opening the progress modal instead of showing an error.

Acceptance criteria

  • The sync button works against MusicServer 5.0
  • A second click while a sync runs shows the progress instead of an error
**Breaking change in MusicServer 5.0:** sync endpoints are POST only. Fix this before (or together with) deploying the new server, or the sync button stops working. ## What changed on the server These endpoints changed from GET to POST, on both legacy routes and `/api/v1`: - `/sync`, `/sync/new`, `/sync/quick` (sync only changes) - `/sync/full`, `/sync/new/full` (full sync) - `/sync/reset` (deletes all soundtracks and songs) A GET on these paths now returns **404** and does nothing. `GET /sync/progress` is unchanged. Starting a sync while one is running returns **423 Locked**. ## Change in MusicFrontend `src/components/items/extraButtons.vue`, `APIsyncSoundtracks()`: ```js this.axios({ method: "post", url: `${window.__RUNTIME_CONFIG__.API_HOSTNAME}/sync`, }) ``` Also handle 423 (a sync is already running), for example by opening the progress modal instead of showing an error. ## Acceptance criteria - The sync button works against MusicServer 5.0 - A second click while a sync runs shows the progress instead of an error
Author
Owner

Update: /sync/new, /sync/quick and /sync/new/full were removed from the server. Only POST /sync and POST /sync/full exist now. A 423 response body is now {"error": "Syncing is in progress"} instead of a bare string (the status code is unchanged).

**Update:** `/sync/new`, `/sync/quick` and `/sync/new/full` were removed from the server. Only `POST /sync` and `POST /sync/full` exist now. A 423 response body is now `{"error": "Syncing is in progress"}` instead of a bare string (the status code is unchanged).
Sign in to join this conversation.
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Sansan/MusicFrontend#1