u
This commit is contained in:
@@ -159,6 +159,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/entity/update.md`](routes/entity/update.md) | `PATCH /entity/{id}` |
|
||||
| [`routes/events.md`](routes/events.md) | `GET /events` |
|
||||
| [`routes/health.md`](routes/health.md) | `GET /health` |
|
||||
| [`routes/health/latency.md`](routes/health/latency.md) | `GET /health/latency` |
|
||||
| [`routes/image/get.md`](routes/image/get.md) | `GET /image/{fullHash}` |
|
||||
| [`routes/labeltemplate/list.md`](routes/labeltemplate/list.md) | `GET /labeltemplate` |
|
||||
| [`routes/labeltemplate/create.md`](routes/labeltemplate/create.md) | `POST /labeltemplate` |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview (All)
|
||||
|
||||
Overview of all 263 API endpoints across all modules.
|
||||
Overview of all 264 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -498,6 +498,9 @@ _none_
|
||||
#### Database health check — `GET /health`
|
||||
_none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Health latency history — `GET /health/latency`
|
||||
_none_
|
||||
- Returns: `200 { raw: { timestamp: int, value: num }[], avg: { timestamp: int, value: num }[], max: { timestamp: int, value: num }[] }`
|
||||
|
||||
### Section: /image
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview
|
||||
|
||||
Overview of all 186 API endpoints across all modules.
|
||||
Overview of all 187 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -381,6 +381,12 @@ _none_
|
||||
- Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }`
|
||||
- Returns: `200 { entity: T19 }`
|
||||
|
||||
### Section: /health
|
||||
|
||||
#### Health latency history — `GET /health/latency`
|
||||
_none_
|
||||
- Returns: `200 { raw: { timestamp: int, value: num }[], avg: { timestamp: int, value: num }[], max: { timestamp: int, value: num }[] }`
|
||||
|
||||
### Section: /labeltemplate
|
||||
|
||||
#### List label templates — `GET /labeltemplate`
|
||||
|
||||
45
docs/api/routes/health/latency.md
Normal file
45
docs/api/routes/health/latency.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# `GET /health/latency`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Health latency history
|
||||
|
||||
Returns the database healthcheck latency (ms) as three series, each oldest first with unix-ms timestamps. `raw` holds the per-minute samples of the last 3 hours; `avg` and `max` hold the 30-minute aggregates (over the last 4 hours of samples) kept for 30 days. Requires a valid JWT; no company selection needed.
|
||||
|
||||
## Response `200`
|
||||
|
||||
Latency series
|
||||
|
||||
```json
|
||||
{
|
||||
"raw": [
|
||||
{
|
||||
"timestamp": 1,
|
||||
"value": 1
|
||||
}
|
||||
],
|
||||
"avg": [
|
||||
{
|
||||
"timestamp": 1,
|
||||
"value": 1
|
||||
}
|
||||
],
|
||||
"max": [
|
||||
{
|
||||
"timestamp": 1,
|
||||
"value": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 401 | Unauthorized |
|
||||
| 500 | Redis read failed |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user