4a0f4cb7d2
All checks were successful
Build and Publish TechDocs / build-and-publish (push) Successful in 1m28s
Change-Id: Ic85508eb87544e6637b1c2a41c15abc40aa35e0c
21 lines
641 B
Markdown
21 lines
641 B
Markdown
# API Reference
|
|
|
|
Base URL: `https://sonar-test-nest4.kyndemo.live`
|
|
|
|
## Items `/api/items`
|
|
|
|
| Method | Path | Body | Response |
|
|
|--------|------|------|----------|
|
|
| GET | `/api/items` | — | Array of items |
|
|
| POST | `/api/items` | `{"name":"...","description":"..."}` | Created item (201) |
|
|
| GET | `/api/items/{id}` | — | Item or 404 |
|
|
| PUT | `/api/items/{id}` | `{"name":"...","description":"..."}` | Updated item |
|
|
| DELETE | `/api/items/{id}` | — | `{"deleted":id}` |
|
|
|
|
## Observability
|
|
|
|
| Path | Description |
|
|
|------|-------------|
|
|
| `/health` | Health check — `{"status":"UP"}` |
|
|
| `/metrics` | Prometheus exposition format |
|