From 5714bda7d5654a5018797032712daa2ef861ce98 Mon Sep 17 00:00:00 2001 From: Jamie Miller Date: Mon, 22 Sep 2025 10:26:35 +1200 Subject: [PATCH] Update README.md Corrected the expected output of the JSON from the API --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9ad2bd5..17a5051 100644 --- a/README.md +++ b/README.md @@ -121,14 +121,14 @@ Save and enable the list. Lidarr will poll the URL on its schedule and import ne ## 🔌 API Endpoints - `GET /artists` - - Returns a JSON array of MusicBrainz Artist IDs optimized for Lidarr custom import: + - Returns a JSON array of dictionaries, each containing a `foreignId` field with a MusicBrainz Artist ID. ```json [ - "b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d", - "some-other-mbid-..." + {"foreignId": "0b987f3c-7264-439a-a1b9-62a69c9b1d91"}, + {"foreignId": "0ebdc5f5-0a11-415a-b6f3-efe0d36c6e9d"} ] ``` - - (Lidarr expects a simple array of MBIDs.) + - Lidarr expects objects with a `foreignId` key pointing to the MBID. - `GET /health` (optional) - Returns basic service health/status (if implemented) — check for `200 OK`.