Skip to content

fix: various RPC API documentation fixes #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: various RPC API documentation fixes #7

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f69848f
fix: update /active response code to 200
isaac-mcfadyen Mar 13, 2025
534298b
fix: fixed typo in name of auth header
isaac-mcfadyen Mar 13, 2025
4592c78
fix: fixed missing </details> tag on /play-later response
isaac-mcfadyen Mar 13, 2025
8daa16c
fix: fixed some more typos in RPC docs
isaac-mcfadyen Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions docs/1.client/rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

<details>
<summary><b>204</b>: No Content</summary>
<code>// No response body...</code>
<summary><b>200</b>: OK</summary>
<code>
<pre>{
"status": "ok"
}</pre>
</code>
</details>

#### **GET** `/is-playing`
Expand Down Expand Up @@ -201,6 +205,7 @@ Accepts a `type` of item to play and an `id` for the item. `type` should be one
"status": "ok"
}</pre>
</code>
</details>

#### **POST** `/play-next`

Expand Down Expand Up @@ -307,6 +312,7 @@ If no item is currently playing but there is one in the playback history, it wil
"status": "ok"
}</pre>
</code>
</details>

#### **GET** `/queue`

Expand Down Expand Up @@ -588,6 +594,7 @@ Note that the index is 1-indexed (starts at 1, not 0). Also note that the queue
"returnQueue": false
}</pre>
</code>
</details>

<details>
<summary><b>200</b>: OK</summary>
Expand Down Expand Up @@ -639,12 +646,15 @@ Accepts a `position` in seconds to seek to. Note that `/now-playing` returns a t
"position": 30
}</pre>
</code>
</details>

<details>
<summary><b>204</b>: No Content</summary>
```json
// No Response Body...
```
<summary><b>200</b>: OK</summary>
<code>
<pre>{
"status": "ok"
}</pre>
</code>
</details>

#### **GET** `/volume`
Expand Down