docs: add docs folder (architecture, developer, usage); update README; wire probe TTL cache + concurrency notes into docs
This commit is contained in:
38
docs/usage/api.md
Normal file
38
docs/usage/api.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Usage: API Examples
|
||||
|
||||
## Projection Query via Gateway (HTTP → gRPC)
|
||||
```bash
|
||||
curl -sS -X POST \
|
||||
-H "x-tenant-id: tenant-a" \
|
||||
-H "x-correlation-id: demo" \
|
||||
-H "traceparent: 00-00000000000000000000000000000001-0000000000000001-01" \
|
||||
http://localhost:8080/v1/query/User \
|
||||
-d '{"uqf":"{\"eq\":{\"id\":\"u1\"}}"}'
|
||||
```
|
||||
|
||||
## Projection Query via gRPC (direct, internal)
|
||||
```bash
|
||||
grpcurl -d '{"tenant_id":"tenant-a","view_type":"User","uqf":"{}"}' \
|
||||
-H 'x-tenant-id: tenant-a' \
|
||||
-H 'x-correlation-id: demo' \
|
||||
-H 'traceparent: 00-00000000000000000000000000000001-0000000000000001-01' \
|
||||
-plaintext localhost:9090 projection.gateway.v1.QueryService/ExecuteQuery
|
||||
```
|
||||
|
||||
## Aggregate Command via Gateway (HTTP → gRPC)
|
||||
```bash
|
||||
curl -sS -X POST \
|
||||
-H "x-tenant-id: tenant-a" \
|
||||
-H "x-correlation-id: demo" \
|
||||
-H "traceparent: 00-00000000000000000000000000000001-0000000000000001-01" \
|
||||
http://localhost:8080/v1/aggregate/BankAccount/command \
|
||||
-d '{"id":"acc-1","command_type":"Open","payload":{"owner":"Alice"}}'
|
||||
```
|
||||
|
||||
## Runner Admin via Gateway (HTTP → gRPC)
|
||||
```bash
|
||||
curl -sS -X POST \
|
||||
-H "x-tenant-id: tenant-a" \
|
||||
-H "authorization: Bearer <token>" \
|
||||
http://localhost:8080/admin/runner/drain?wait_ms=0
|
||||
```
|
||||
Reference in New Issue
Block a user