From f69848fee67e0118a251ff9219e8e1b90022e494 Mon Sep 17 00:00:00 2001 From: Isaac McFadyen Date: Thu, 13 Mar 2025 15:17:21 -0400 Subject: [PATCH 1/4] fix: update /active response code to 200 --- docs/1.client/rpc.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/1.client/rpc.md b/docs/1.client/rpc.md index efbb8d1..c3dcf23 100644 --- a/docs/1.client/rpc.md +++ b/docs/1.client/rpc.md @@ -28,8 +28,12 @@ The API endpoints documented below are all nested under `/api/v1/playback`. Responds with an empty body and status code `204: No Content`. This endpoint can be used to quickly check that the RPC server is still active.
-204: No Content -// No response body... +200: OK + +
{
+  "status": "ok"
+}
+
#### **GET** `/is-playing` From 534298bed5e1a76a20e3016b7e27ec26b5cd6207 Mon Sep 17 00:00:00 2001 From: Isaac McFadyen Date: Thu, 13 Mar 2025 16:42:45 -0400 Subject: [PATCH 2/4] fix: fixed typo in name of auth header --- docs/1.client/rpc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/1.client/rpc.md b/docs/1.client/rpc.md index c3dcf23..f6f1756 100644 --- a/docs/1.client/rpc.md +++ b/docs/1.client/rpc.md @@ -15,7 +15,7 @@ We've observed that using `127.0.0.1` when IPv4 is disabled tends to break and n Unless explicitly disabled within Cider, all API requests require a valid API token. You can generate this token, or turn off authentication, from the menu at **Settings -> Connectivity -> Manage External Application Access to Cider** within Cider. -The generated token should be passed in the `apitoken` header of all requests. Do not prefix the token with `Bearer` or any other string; just pass the token by itself in the header. +The generated token should be passed in the `apptoken` header of all requests. Do not prefix the token with `Bearer` or any other string; just pass the token by itself in the header. This token is not required if disabled within the settings menu. From 4592c78437af9b3dab899a20b71a3d73525d3592 Mon Sep 17 00:00:00 2001 From: Isaac McFadyen Date: Thu, 13 Mar 2025 16:58:04 -0400 Subject: [PATCH 3/4] fix: fixed missing tag on /play-later response --- docs/1.client/rpc.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/1.client/rpc.md b/docs/1.client/rpc.md index f6f1756..e85012e 100644 --- a/docs/1.client/rpc.md +++ b/docs/1.client/rpc.md @@ -205,6 +205,7 @@ Accepts a `type` of item to play and an `id` for the item. `type` should be one "status": "ok" } + #### **POST** `/play-next` From 8daa16c799dd8584eccc46a47edfd1218ea9ec4e Mon Sep 17 00:00:00 2001 From: Isaac McFadyen Date: Thu, 13 Mar 2025 16:59:52 -0400 Subject: [PATCH 4/4] fix: fixed some more typos in RPC docs --- docs/1.client/rpc.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/1.client/rpc.md b/docs/1.client/rpc.md index e85012e..aa69525 100644 --- a/docs/1.client/rpc.md +++ b/docs/1.client/rpc.md @@ -312,6 +312,7 @@ If no item is currently playing but there is one in the playback history, it wil "status": "ok" } + #### **GET** `/queue` @@ -593,6 +594,7 @@ Note that the index is 1-indexed (starts at 1, not 0). Also note that the queue "returnQueue": false } +
200: OK @@ -644,12 +646,15 @@ Accepts a `position` in seconds to seek to. Note that `/now-playing` returns a t "position": 30 } +
-204: No Content -```json -// No Response Body... -``` +200: OK + +
{
+  "status": "ok"
+}
+
#### **GET** `/volume`