GRI-1763: Signage MVP API and WebSocket contract (docs) #79

Merged
vivy merged 1 commit from docs/GRI-1763-mvp-api-ws-contract into dev 2026-11-09 17:57:33 +00:00
Member

Summary

Cuts the WebSocket and REST API contract down to the MVP, so Prismancer (panel) and Voidgazer (Rust units) have something concrete to build against.

  • plan/shared/protocol.md / crates/shared/src/protocol.rs: the MVP message set — EnrolmentUpdate (pending/approved/rejected), PlaylistPush, MediaManifest/MediaManifestEntry/MediaKind, Heartbeat. Everything else (full Status, Configuration, live commands, update) is marked later, not deleted.
  • plan/server/rest-api.md: concrete MVP routes — first-user setup, session, devices (list/approve/block/rename), IP rules, media (upload/list/delete/add-URL), playlists (CRUD, items, assign to device). Everything else stays principles-only for now.

Checked against enrolment.md, media-pipeline.md and content.rs so field names and semantics agree with the units already landed on dev (admission, client-IP, backoff, media cache plan, sha256 verify).

Test plan

  • cargo test -p shared --lib — 20/20 pass, including the 3 new protocol tests
  • scripts/local-gates.sh --rust-only — every gate passed
## Summary Cuts the WebSocket and REST API contract down to the MVP, so Prismancer (panel) and Voidgazer (Rust units) have something concrete to build against. - `plan/shared/protocol.md` / `crates/shared/src/protocol.rs`: the MVP message set — `EnrolmentUpdate` (pending/approved/rejected), `PlaylistPush`, `MediaManifest`/`MediaManifestEntry`/`MediaKind`, `Heartbeat`. Everything else (full `Status`, `Configuration`, live commands, update) is marked *later*, not deleted. - `plan/server/rest-api.md`: concrete MVP routes — first-user setup, session, devices (list/approve/block/rename), IP rules, media (upload/list/delete/add-URL), playlists (CRUD, items, assign to device). Everything else stays principles-only for now. Checked against `enrolment.md`, `media-pipeline.md` and `content.rs` so field names and semantics agree with the units already landed on `dev` (admission, client-IP, backoff, media cache plan, sha256 verify). ## Test plan - [x] `cargo test -p shared --lib` — 20/20 pass, including the 3 new protocol tests - [x] `scripts/local-gates.sh --rust-only` — every gate passed
GRI-1763: cut the API and WebSocket contract to the MVP
Some checks failed
CI / cargo fmt (pull_request) Successful in 17s
CI / the pre-push hook (pull_request) Successful in 18s
CI / cargo deny advisories (pull_request) Failing after 2m5s
CI / cargo deny (pull_request) Successful in 2m5s
CI / repository boundary (pull_request) Successful in 34s
CI / cargo clippy (pull_request) Successful in 9m48s
CI / cargo test (pull_request) Successful in 9m53s
CI / frontend-web (pull_request) Successful in 10m33s
CI / Notify gate failed (pull_request) Has been skipped
CI / CI (pull_request) Successful in 2s
d80f107a73
vivy merged commit 5805a9afc6 into dev 2026-11-09 17:57:33 +00:00
vivy deleted branch docs/GRI-1763-mvp-api-ws-contract 2026-11-09 17:57:33 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
Grimoirix/grimoire-of-digital-signage!79
No description provided.