yolo/arr
3
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects Releases Wiki Activity

axum skeleton with health and OpenAPI #5

New Issue
Closed
opened 2026-08-22 18:22:38 +01:00 by naps62-yolo · 0 comments
naps62-yolo commented 2026-08-22 18:22:38 +01:00
Owner
Copy Link
Copy Source

DESIGN.md §9.1 — the HTTP API is the product surface and the web UI is just a
client of it.

  • axum server bound per config, no authentication (§2).
  • GET /api/health reporting reachability of Prowlarr, Transmission and TMDB.
  • OpenAPI generated from handler annotations and served, plus a browsable UI.
  • A just gen-client recipe that generates the TypeScript client from the
    spec into web/src/api/.

Acceptance: the spec is generated rather than hand-written, and adding a
handler without annotating it fails CI.

Depends on: #1, #3

Labels: phase/1-skeleton, area/api, difficulty/moderate, type/feature

`DESIGN.md` §9.1 — the HTTP API is the product surface and the web UI is just a client of it. - axum server bound per config, no authentication (§2). - `GET /api/health` reporting reachability of Prowlarr, Transmission and TMDB. - OpenAPI generated from handler annotations and served, plus a browsable UI. - A `just gen-client` recipe that generates the TypeScript client from the spec into `web/src/api/`. Acceptance: the spec is generated rather than hand-written, and adding a handler without annotating it fails CI. --- **Depends on:** #1, #3 Labels: `phase/1-skeleton`, `area/api`, `difficulty/moderate`, `type/feature`
naps62-yolo added the area/apidifficulty/moderatephase/1-skeletontype/feature labels 2026-08-22 18:22:38 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area/api
arr-api
 area/ci
CI and test harness
 area/compat
arr-compat
 area/core
arr-core
 area/daemon
arr-daemon
 area/db
arr-db
 area/dl
arr-dl
 area/indexer
arr-indexer
 area/infra
workspace and tooling
 area/meta
arr-meta
 area/parse
arr-parse
 area/probe
arr-probe
 area/subs
arr-subs crate: providers, extraction, translation, sync
 area/web
web/
 difficulty/easy
bounded, obvious approach, few files
 difficulty/hard
subtle correctness or cross-cutting
 difficulty/moderate
multiple files, judgement, an interface to design
 difficulty/trivial
one file, mechanical, no design decisions
 phase/1-skeleton
workspace, CI, config, database, empty API and SPA
 phase/2-logic
parsing and policy engine, pure, no network
 phase/3-sourcing
TMDB and Prowlarr, read-only
 phase/4-movies
movies end to end
 phase/5-ui
search, buckets, library views, queues
 phase/6-tv
seasons, episodes, tracking, derived status
 phase/7-people
owner tags and notifications
 phase/8-compat
Jellyseerr shim
 phase/9-subtitles
build order: subtitles, DESIGN.md §15
 type/bug
type/chore
type/feature
type/test
No Label area/api difficulty/moderate phase/1-skeleton type/feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
hermes (Hermes (agent)) naps62 (Miguel Palhas) naps62-yolo (naps62-yolo (agent))
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: yolo/arr#5
Delete Branch "%!s()"

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?