added random playlist example in json-api.md

[AlexeyMal]

added random playlist example

Summary by CodeRabbit

• Documentation
  • Added a JSON API example showing an endless playlist, applying a preset indefinitely, randomized effects and colors, detailed segment/brightness configuration, and instructions for uploading the payload and applying the playlist via the API.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 19b8f0e6-7c1d-4c07-99aa-c8fc10ae727c

📥 Commits

Reviewing files that changed from the base of the PR and between b38cb9d and 3dac886.

📒 Files selected for processing (1)

• docs/interfaces/json-api.md

✅ Files skipped from review due to trivial changes (1)

• docs/interfaces/json-api.md

---

Walkthrough

Documentation update adds a new JSON example in the Playlists section demonstrating configuration of an endless playlist with preset 12. The example shows random effect, random palette selection, and segment brightness settings for the preset payload.

Changes

Playlists example

Layer / File(s)	Summary
Sample playlist example docs/interfaces/json-api.md	Added JSON example for endless playlist configuration (repeat: 0) that applies preset 12 with fx: "r", pal: "r", randomized segment col: "r", and explains numeric payload IDs and upload/apply steps (/edit upload, POST {"ps":9} to /json/state).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰✨ A playlist spins 'round without end,
Preset twelve dreams in a colorful blend.
Random hues tumble, effects leap and pry,
I hop through the docs as the LEDs sigh —
Joyful bytes beneath the sky.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately describes the main change: adding a random playlist example to the json-api.md documentation file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

✨ Simplify code

• Create PR with simplified code

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

docs/interfaces/json-api.md (1)

350-355: 💤 Low value

Format the JSON example for readability/correct copy-paste.

The "12" preset object (and nested "seg" fields) is currently very dense on one line, which increases the risk of accidental edits when users copy it (missing commas/quotes/brackets, etc.). Consider re-indenting the JSON to match the style used in earlier examples in this file.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/interfaces/json-api.md` around lines 350 - 355, Reformat the JSON
example so the preset objects (especially the "12" preset and its nested "seg"
array) are pretty-printed with proper indentation and line breaks like the
earlier examples; expand the single-line object for "12" into multiple lines for
each key (bri, mainseg, on, seg, transition, n) and likewise format the seg
object fields (bri, c1/c2/c3, cct, col, frz, fx, grp, id, ix, m12, mi, o1/o2/o3,
of, on, pal, rev, sel, set, si, spc, start, stop, sx, fxdef) so commas, brackets
and quotes are clear and the "9" -> "playlist" structure remains readable for
safe copy/paste.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/interfaces/json-api.md`:
- Around line 348-356: The example uses top-level numeric keys "9" (playlist
object with "playlist":{...}) and "12" (preset/preset segment under
"seg":{...}); add one short clarifying sentence below the JSON explaining that
those numeric keys are resource IDs (playlist ID 9 and preset ID 12), that
POSTing this payload to /json/cfg will persist/save both the playlist and
preset, and that to apply a playlist immediately you would instead POST an
appropriate state update to /json/state (or use the "playlist" command) —
reference the "9" playlist and "12" preset in the sentence so readers know which
parts are persisted vs applied.
- Around line 348-356: The sample playlist JSON includes an undocumented "r"
field inside the playlist object (the object keyed as "9" with
"playlist":{...}); either remove that "r" property from the example to match the
documented Playlist schema (which lists only ps, dur, transition, repeat, end),
or update the Playlist table above to add a clear entry for "r" (explaining its
type and semantics for playlists). Modify the sample under the
"AllRandomPlaylist" example or the Playlist object documentation accordingly so
the schema and example are consistent.

---

Nitpick comments:
In `@docs/interfaces/json-api.md`:
- Around line 350-355: Reformat the JSON example so the preset objects
(especially the "12" preset and its nested "seg" array) are pretty-printed with
proper indentation and line breaks like the earlier examples; expand the
single-line object for "12" into multiple lines for each key (bri, mainseg, on,
seg, transition, n) and likewise format the seg object fields (bri, c1/c2/c3,
cct, col, frz, fx, grp, id, ix, m12, mi, o1/o2/o3, of, on, pal, rev, sel, set,
si, spc, start, stop, sx, fxdef) so commas, brackets and quotes are clear and
the "9" -> "playlist" structure remains readable for safe copy/paste.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e7383106-b1af-4603-abdb-28b78eb0982d

📥 Commits

Reviewing files that changed from the base of the PR and between 2e6aef0 and b38cb9d.

📒 Files selected for processing (1)

• docs/interfaces/json-api.md

[AlexeyMal]

resolved coderabbitai reported issues