Skip to content

docs: add -L -k flags to README curl examples #339

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
Blackgaurd merged 1 commit into from
May 15, 2026
Merged

docs: add -L -k flags to README curl examples #339

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@ This additionally exposes `localhost:3000` (builder), `localhost:5432` (Postgres
Build mock OHLC data (root dataset):

```bash
curl -X POST "http://localhost/api/v1/build/mock-ohlc/0.1.0?start=2024-01-01&end=2024-01-31"
curl -L -k -X POST "http://localhost/api/v1/build/mock-ohlc/0.1.0?start=2024-01-01&end=2024-01-31"
```

Build a derived dataset (automatically builds `mock-ohlc` first if data is missing):

```bash
curl -X POST "http://localhost/api/v1/build/mock-daily-close/0.1.0?start=2024-01-01&end=2024-01-31"
curl -L -k -X POST "http://localhost/api/v1/build/mock-daily-close/0.1.0?start=2024-01-01&end=2024-01-31"
```

Fetch data for a dataset:

```bash
curl "http://localhost/api/v1/data/mock-ohlc/0.1.0?start=2024-01-01&end=2024-01-31"
curl -L -k "http://localhost/api/v1/data/mock-ohlc/0.1.0?start=2024-01-01&end=2024-01-31"
```

These examples go through Caddy on port 80. In dev mode (`just docker-up-dev` or `just backend-dev`), replace `localhost` with `localhost:3000` to hit the builder server directly.
Expand Down
Loading