GRI-1763: Signage MVP API and WebSocket contract (docs) #79
No reviewers
Labels
No labels
Area/Backend
Area/Database
Area/Docs
Area/Frontend
Area/Infra
Area/Security
Area/Tests
Area/Tooling
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Lang/Python
Lang/Rust
Lang/Shell
Lang/SQL
Lang/TypeScript
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Routing
Auto
Routing
Hold
Routing
Human
Status
Abandoned
Status
Blocked
Status
Need More Info
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
Grimoirix/grimoire-of-digital-signage!79
Loading…
Reference in a new issue
No description provided.
Delete branch "docs/GRI-1763-mvp-api-ws-contract"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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 (fullStatus,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.mdandcontent.rsso field names and semantics agree with the units already landed ondev(admission, client-IP, backoff, media cache plan, sha256 verify).Test plan
cargo test -p shared --lib— 20/20 pass, including the 3 new protocol testsscripts/local-gates.sh --rust-only— every gate passed