zlh-grind/Codex/API/OPEN_ITEMS.md

51 lines
3.2 KiB
Markdown

# API — Open Items
Only keep unfinished API work here.
## Active
- normalize backup response shape: define canonical success bodies for list/create/restore/delete and a stable error envelope that preserves agent details
- service discovery migration: audit edge publish/DNS/Cloudflare/Technitium, Prometheus SD, dev IDE wildcard, and post-provision hot paths for direct host assumptions
- provisioning validation follow-up where API behavior is involved
- verify Portal compatibility after API JWT issuer/audience tightening, especially refresh flow and hosted IDE token flow
- verify canonical and compatibility file routes still behave identically across list/stat/read/download/delete/put/revert/upload paths after helper extraction
- align merged live-status readiness fields so Portal-facing `agentReady` semantics fully match semantic `/ready`
- verify orphan/manual delete behavior after retirement of legacy PortPool release logic
- decide whether the remaining Portal-side `/api/agent/:serverId/:action` bridge should be deleted outright or formally kept as compatibility-only Portal-owned behavior
## Cleanup / consolidation priorities
- fold repeated ownership/auth/IP-guard patterns into small concrete helpers without hiding route intent
- split oversized route/service files by responsibility without changing route contracts
- keep backup/restore status shaping and async-dispatch logic explicit, but remove duplicated mapping/normalization paths where possible
- keep stream-vs-JSON forwarding rules centralized in one place and avoid route-local reimplementation
- keep archived legacy flows out of the live tree unless they are intentionally revived and revalidated against the current schema/contracts
## Completed and moved out of active cleanup
- Node/runtime pinning is no longer an open cleanup-only item; Node 24 pinning is now treated as current repo state
- `node-fetch` removal and built-in `fetch` migration are no longer open items
- initial file-proxy route deduplication has been completed; only compatibility verification and follow-on cleanup remain open
- Prisma config migration is no longer an open item
- baseline proxy cookie/log hardening is no longer an open item
- worker-era provisioning and detached legacy port reservation have been archived rather than treated as active API surfaces
## Cleanup rule
- prefer behavior-preserving folding over broad refactors
- merge repeated flows, not concepts
- keep helpers small and concrete
- reduce route-local duplication before introducing new abstractions
- treat security/runtime changes as contract-sensitive validation work once they affect auth, cookies, or route compatibility
## Verify before re-opening
- hosted IDE token + hosted URL flow
- backup forwarding semantics
- readiness polling/cache behavior
- quota enforcement on create flow
- restore async-start contract + status polling semantics
- streamed file edit/revert forwarding through both canonical and compatibility routes
- older-session re-login behavior after JWT tightening
- Portal-side `/api/agent` bridge usage before deleting any remaining compatibility code around instance lookup assumptions
## Not API-owned
- agent-local backup implementation details
- portal-only UX/polish
- PBS / infra backup strategy