Skip to content

docs(api): note that shuffle_context before play starts on a random track #314

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

Merged
devgianlu merged 1 commit into from
Jun 5, 2026
Merged

docs(api): note that shuffle_context before play starts on a random track #314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions api-spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,12 @@ paths:
description: Successful response
/player/play:
post:
description: Starts playing new content
description: >-
Starts playing new content. To start a context shuffled (on a random
track), enable shuffle first via /player/shuffle_context and then call
this. Calling /player/shuffle_context after play only shuffles the
upcoming queue and keeps the current (first) track, so play alone (or
shuffle after play) always begins on the context's first track.
requestBody:
$ref: '#/components/schemas/play'
responses:
Expand Down Expand Up @@ -268,7 +273,10 @@ paths:
description: Successful response
/player/shuffle_context:
post:
description: Toggle shuffling context
description: >-
Toggle shuffling the context. Enabling it BEFORE /player/play makes
playback start on a random track; enabling it after play only reshuffles
the upcoming queue and keeps the current (first) track.
requestBody:
content:
application/json:
Expand Down
Loading