initial commit
All checks were successful
Build and Publish TechDocs / build-and-publish (push) Successful in 1m27s
All checks were successful
Build and Publish TechDocs / build-and-publish (push) Successful in 1m27s
Change-Id: I35f00d25ebe8c71518adecf99aa11ac9fcad0671
This commit is contained in:
20
docs/api.md
Normal file
20
docs/api.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# API Reference
|
||||
|
||||
Base URL: `https://cicd-deep-link-test.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 |
|
||||
|------|-------------|
|
||||
| `/actuator/health` | Health check — `{"status":"UP"}` |
|
||||
| `/metrics` | Prometheus exposition format |
|
||||
Reference in New Issue
Block a user