refactor: RESTful and sgl/smg compliant API

Author: alphabetc1

README.md

@@ -4,13 +4,38 @@ A lightweight router for SGLang diffusion workers.
 
 It provides worker registration, load balancing, health checking, and request proxying for diffusion generation APIs.
 
+---
+
+## Table of Contents
+
+- [Highlights](#highlights)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+  - [Start diffusion workers](#start-diffusion-workers)
+  - [Start the router](#start-the-router)
+  - [Test the router](#test-the-router)
+- [Router API](#router-api)
+  - [Inference Endpoints](#inference-endpoints)
+  - [Videos Result Query](#videos-result-query)
+  - [Model Discovery and Health Checks](#model-discovery-and-health-checks)
+  - [Worker Management APIs](#worker-management-apis)
+  - [Optional (business-dependent)](#optional-business-dependent)
+- [`update_weights_from_disk` behavior](#update_weights_from_disk-behavior)
+- [Benchmark Scripts](#benchmark-scripts)
+- [Acknowledgment](#acknowledgment)
+- [Notes](#notes)
+
+---
+
 ## Highlights
 
 - `least-request` routing by default, with `round-robin` and `random`.
 - Background health checks with quarantine after repeated failures.
 - Router APIs for worker registration, health inspection, and proxy forwarding.
 - `update_weights_from_disk` broadcast to all healthy workers.
 
+---
+
 ## Installation
 
 From repository root:
@@ -31,6 +56,8 @@ Workers require SGLang diffusion support:
 uv pip install "sglang[diffusion]" --prerelease=allow
 ```
 
+---
+
 ## Quick Start
 
 ### Start diffusion workers
@@ -122,16 +149,48 @@ curl -X POST http://localhost:30081/generate_video \
 curl http://localhost:30081/health_workers
 ```
 
+---
+
 ## Router API
 
-- `POST /add_worker`: add worker via query (`?url=`) or JSON body.
-- `GET /list_workers`: list registered workers.
-- `GET /health`: aggregated router health.
-- `GET /health_workers`: per-worker health and active request counts.
-- `POST /generate`: forwards to worker `/v1/images/generations`.
-- `POST /generate_video`: forwards to worker `/v1/videos`.
-- `POST /update_weights_from_disk`: broadcast to healthy workers.
-- `GET|POST|PUT|DELETE /{path}`: catch-all proxy forwarding.
+### Inference Endpoints
+
+| Method | Path | Description |
+|---|---|---|
+| `POST` | `/v1/images/generations` | Entrypoint for text-to-image generation |
+| `POST` | `/v1/videos` | Entrypoint for text-to-video generation |
+
+### Videos Result Query
+
+| Method | Path | Description |
+|---|---|---|
+| `GET` | `/v1/videos` | List or poll video jobs |
+| `GET` | `/v1/videos/{video_id}` | Get status/details of a single video job |
+| `GET` | `/v1/videos/{video_id}/content` | Download generated video content |
+
+### Model Discovery and Health Checks
+
+| Method | Path | Description |
+|---|---|---|
+| `GET` | `/v1/models` | OpenAI-style model discovery |
+| `GET` | `/health` | Basic health probe |
+
+### Worker Management APIs
+
+| Method | Path | Description |
+|---|---|---|
+| `POST` | `/workers` | Register a worker |
+| `GET` | `/workers` | List workers (including health/load) |
+| `GET` | `/workers/{worker_id}` | Get worker details |
+| `PUT` | `/workers/{worker_id}` | Update worker configuration |
+| `DELETE` | `/workers/{worker_id}` | Deregister a worker |
+
+### Optional (business-dependent)
+
+| Method | Path | Description |
+|---|---|---|
+| `POST` | `/update_weights_from_disk` | Reload weights from disk (ops/admin use) |
+
 
 ## `update_weights_from_disk` behavior
 
@@ -165,6 +224,8 @@ Response shape:
 }
 ```
 
+---
+
 ## Benchmark Scripts
 
 Benchmark scripts are available under `tests/benchmarks/diffusion_router/` and are intended for manual runs.
@@ -190,29 +251,14 @@ SGLANG_USE_MODELSCOPE=TRUE python tests/benchmarks/diffusion_router/bench_routin
     --max-concurrency 4
 ```
 
-## Project Layout
-
-```text
-.
-├── docs/
-│   └── update_weights_from_disk.md
-├── src/sglang_diffusion_routing/
-│   ├── cli/
-│   └── router/
-├── tests/
-│   ├── benchmarks/
-│   │   └── diffusion_router/
-│   │       ├── bench_router.py
-│   │       └── bench_routing_algorithms.py
-│   └── unit/
-├── pyproject.toml
-└── README.md
-```
+---
 
 ## Acknowledgment
 
 This project is derived from [radixark/miles#544](https://github.com/radixark/miles/pull/544). Thanks to the original authors for their work.
 
+---
+
 ## Notes
 
 - Quarantined workers are intentionally not auto-reintroduced.