Skip to content

Commit 8a59af7

Browse files
committed
docs(readme): document API command and endpoints
1 parent b2a853a commit 8a59af7

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ What exists today:
3333
- PostgreSQL-backed raw check execution storage
3434
- persisted current check state
3535
- migration CLI via `cmd/pulse-migrate`
36+
- early REST API via `cmd/pulse-api`
3637

3738
What does not exist yet in a finished form:
3839

3940
- finalized service-level aggregation
40-
- query/read API for current and historical state
41+
- complete query/read API for current and historical state
4142
- public/internal status page generation
4243
- production-ready logging and observability
4344
- stable external interfaces
@@ -75,12 +76,26 @@ Run with:
7576
CONFIG_DIR=./examples go run ./cmd/pulse
7677
```
7778

79+
Run API with:
80+
81+
```bash
82+
API_LISTEN_ADDR=:8080 CONFIG_DIR=./examples go run ./cmd/pulse-api
83+
```
84+
85+
Implemented API endpoints:
86+
87+
- `GET /v1/services`
88+
- `GET /v1/services/{serviceId}/checks/state`
89+
- `GET /v1/services/{serviceId}/checks/{checkId}/executions`
90+
- `GET /v1/services/{serviceId}/checks/{checkId}/timeline`
91+
7892
## Notes
7993

8094
A few implementation details are intentionally narrow at this stage:
8195

8296
- gRPC support currently targets only the standard health check API: `grpc.health.v1.Health/Check`
8397
- raw execution history and current check state are stored in PostgreSQL
98+
- API configuration is read from the latest valid hot-reloaded config snapshot
8499
- internal architecture is still evolving
85100

86101
## Important

0 commit comments

Comments
 (0)