From b14847f94d80b0e047c735e57031bdde6e4c4bd7 Mon Sep 17 00:00:00 2001 From: Nik Afiq Date: Sat, 6 Dec 2025 18:31:44 +0900 Subject: [PATCH] Update README with Swagger documentation and clarify create show endpoint --- backend/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/backend/README.md b/backend/README.md index 7b2ae75..0e30d99 100644 --- a/backend/README.md +++ b/backend/README.md @@ -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