Skip to content

docs(frontend): update list of available API endpoints #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emiridbest merged 1 commit into from
Sep 18, 2026
Merged

docs(frontend): update list of available API endpoints #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ npm install
npm run dev
```

The UI uses Webpack mode because the native Windows SWC binary may be unavailable. Browser requests use the same-origin `/api` proxy, so the browser does not need CORS access to the Python API. The proxy targets `http://127.0.0.1:8080` by default. Set `BACKEND_API_URL` in the frontend environment to override it:
The UI uses Webpack mode because the native Windows SWC binary may be unavailable. Browser requests use the same-origin `/api` proxy, so the browser does not need CORS access to the Python API. The proxy targets `http://127.0.0.1:8080` by default.

```powershell
$env:BACKEND_API_URL = "http://127.0.0.1:8080"
Expand All @@ -22,8 +22,15 @@ The current backend API surface is:
- `GET /allele-frequency?variant=...&project_id=...&min_cell_size=...`
- `POST /linear-regression` with `features`, `target`, `project_id`, `filters`, and `min_cell_size`.
- `POST /logistic-regression` with `features`, `target`, `project_id`, `filters`, and `min_cell_size`.
- `GET /metadata`
- `GET /examples/{name}`
- `POST /run`
- `GET /run/{run_id}`
- `GET /overseer`
- `POST /overseer/{spec_hash}/{decision}`
- `GET /audit`


The Next.js route at `app/api/[...path]/route.js` forwards those requests server-side, avoiding browser CORS. Metadata, example loading, run polling, overseer, and audit routes are not exposed by the current backend, so the UI uses static variable/project choices and the existing example selector includes a `logistic_regression` mode for the new endpoint.

Start the Python API from the repository root on port 8080, then start this frontend:

Expand Down
Loading