Build REST API for channel/collection/schedule CRUD #2

New Issue

2026-02-26T23:45:57+01:00

timothy commented

2026-02-26 23:45:57 +01:00

Problem

ErsatzTV has no REST API for creating, updating, or deleting channels, collections, schedules, or playouts. The only way to manage these is through the Blazor Server UI or direct SQLite database manipulation.

Direct DB manipulation is fragile because:

EF Core uses TPT inheritance (e.g. ProgramScheduleItem → ProgramScheduleOneItem) — must insert into subtypes
Many NOT NULL constraints and enum values to get right (ScheduleKind, PlaybackOrder, CollectionType, etc.)
Container must be stopped for writes (WAL mode only allows concurrent reads)
No validation — easy to create broken state (e.g. ScheduleKind=0 causes "Cannot build playout type None")

Proposed API

REST endpoints under /api/ following the existing pattern:

Channels

POST   /api/channels                    # Create channel
PUT    /api/channels/{id}               # Update channel
DELETE /api/channels/{id}               # Delete channel
GET    /api/channels                    # (exists) List channels
GET    /api/channels/{number}           # (exists) Get channel by number

Collections

POST   /api/collections                 # Create collection
PUT    /api/collections/{id}            # Update collection
DELETE /api/collections/{id}            # Delete collection
POST   /api/collections/{id}/items      # Add items to collection
DELETE /api/collections/{id}/items/{itemId}  # Remove item

Schedules

POST   /api/schedules                   # Create schedule
PUT    /api/schedules/{id}              # Update schedule
DELETE /api/schedules/{id}              # Delete schedule
POST   /api/schedules/{id}/items        # Add schedule item
DELETE /api/schedules/{id}/items/{itemId}    # Remove schedule item

Playouts

POST   /api/playouts                    # Create playout (link channel to schedule)
DELETE /api/playouts/{id}               # Delete playout
POST   /api/channels/{number}/playout/reset  # (exists) Reset playout

Implementation Approach

Follow existing MediatR CQRS pattern — create Command + Handler pairs in ErsatzTV.Application/
Add controllers in ErsatzTV/Controllers/
Reuse existing domain validation from Blazor page code-behind
Return proper HTTP status codes (201 Created, 404 Not Found, 422 Validation Error)
All mutations go through EF Core (no direct SQL) so cascade deletes and constraints are handled

## Problem ErsatzTV has no REST API for creating, updating, or deleting channels, collections, schedules, or playouts. The only way to manage these is through the Blazor Server UI or direct SQLite database manipulation. Direct DB manipulation is fragile because: - EF Core uses TPT inheritance (e.g. `ProgramScheduleItem` → `ProgramScheduleOneItem`) — must insert into subtypes - Many NOT NULL constraints and enum values to get right (ScheduleKind, PlaybackOrder, CollectionType, etc.) - Container must be stopped for writes (WAL mode only allows concurrent reads) - No validation — easy to create broken state (e.g. ScheduleKind=0 causes "Cannot build playout type None") ## Proposed API REST endpoints under `/api/` following the existing pattern: ### Channels ``` POST /api/channels # Create channel PUT /api/channels/{id} # Update channel DELETE /api/channels/{id} # Delete channel GET /api/channels # (exists) List channels GET /api/channels/{number} # (exists) Get channel by number ``` ### Collections ``` POST /api/collections # Create collection PUT /api/collections/{id} # Update collection DELETE /api/collections/{id} # Delete collection POST /api/collections/{id}/items # Add items to collection DELETE /api/collections/{id}/items/{itemId} # Remove item ``` ### Schedules ``` POST /api/schedules # Create schedule PUT /api/schedules/{id} # Update schedule DELETE /api/schedules/{id} # Delete schedule POST /api/schedules/{id}/items # Add schedule item DELETE /api/schedules/{id}/items/{itemId} # Remove schedule item ``` ### Playouts ``` POST /api/playouts # Create playout (link channel to schedule) DELETE /api/playouts/{id} # Delete playout POST /api/channels/{number}/playout/reset # (exists) Reset playout ``` ## Implementation Approach - Follow existing MediatR CQRS pattern — create Command + Handler pairs in `ErsatzTV.Application/` - Add controllers in `ErsatzTV/Controllers/` - Reuse existing domain validation from Blazor page code-behind - Return proper HTTP status codes (201 Created, 404 Not Found, 422 Validation Error) - All mutations go through EF Core (no direct SQL) so cascade deletes and constraints are handled

timothy added the api enhancement priority: medium labels 2026-03-08 23:02:36 +01:00

Build REST API for channel/collection/schedule CRUD #2