Update README with Swagger documentation and clarify create show endpoint

This commit is contained in:
Nik Afiq 2025-12-06 18:31:44 +09:00
parent 338403d80d
commit b14847f94d

View File

@ -23,6 +23,9 @@ go run ./cmd/migrate
# Tests
go test ./...
# Swagger create docs
swag init -g cmd/server/main.go -o ./docs
```
## Docker build (used by compose)
@ -36,4 +39,5 @@ Compose uses the same image for `api` and the one-off `migrate` job.
- `GET /api/v1/current` — current schedule item
- `POST /api/v1/current` — set current episode (expects `{ id, start_time? }`)
- `GET /api/v1/shows` — list of episodes
- `POST /api/v1/shows` — create a new episode (expects `{ ep_num, ep_title, season_name, start_time, playback_length }`)
- `GET /healthz` — health check