fix: add missing response examples across Controller endpoints#673
Merged
Conversation
BrentIO
commented
Jun 21, 2026
BrentIO
commented
Jun 21, 2026
BrentIO
commented
Jun 21, 2026
- Replace UUID v1 (6ba7b810-9dad-11d1-...) with valid v4 - Set controller and client OTA URL examples to the canonical template URL with $$class$$/$$product_hex$$/$$application$$ substitution variables Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
BrentIO
force-pushed
the
worktree-agent-a97fcd0e1daa28b5f
branch
from
51f712d to
0ab6ca8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Multiple Controller endpoints had no complete response examples. Added realistic examples for GET /api/version, GET /api/controllers, GET /api/clients, GET /api/controllers/{uuid}, GET /api/clients/{uuid}, GET /api/cloud-backup, POST /api/cloud-backup 502, POST /api/reboot, and POST /auth.
Also added a
descriptionfield to thedexieFormatschema noting its opaque Dexie.js export structure, and updated the 204 descriptions for/api/rebootand/authto be more informative.Closes #638