initial commit
All checks were successful
Build and Push to ACR / Build and Push (push) Successful in 45s
All checks were successful
Build and Push to ACR / Build and Push (push) Successful in 45s
Change-Id: Iccb9a69a29ce96d618762c5c852c8ec43d9b78df
This commit is contained in:
19
docs/api.md
Normal file
19
docs/api.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# API Reference
|
||||
|
||||
Base URL: `https://test-micro-alex-stable-1.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` | `{"status":"UP"}` |
|
||||
| `/metrics` | Prometheus text format |
|
||||
Reference in New Issue
Block a user