aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-01 20:16:13 +0100
committertv <tv@krebsco.de>2026-11-01 20:16:13 +0100
commit40d362b3714ed78a7c1afa329888e6daf215a9ba (patch)
tree5ad48833d2cc2458e3f535a62ee44d2fc2bb6876 /docs
parent246133cbd44412cd4571bef599a6023d52bc8bad (diff)
dashboard: allow message inspection
Diffstat (limited to 'docs')
-rw-r--r--docs/openapi.yaml6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 798ef8b..bb8323b 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -604,7 +604,11 @@ paths:
every 2 s. Each event's ID is its number. A client that falls behind gets a
`snapshot` again. A `document` event says where the document changed since
the last (at most every 2 s): `{"paths": [[segment, ...], ...]}`, or
- `{"all": true}` when too many changed or the node lost count. When the node
+ `{"all": true}` when too many changed or the node lost count. A `messages`
+ event lists the messages the node exchanged since the last (at most every
+ 2 s, 500 at most): `seq`, `at` (Unix ms), `way` (`sent`, `received`,
+ `refused`), `peer`, `type` (`SYNC`, …), `counted` (its traffic kind), `bytes`
+ and `text` (the message written out). When the node
stops, an `offline` event ends the stream (a client reconnects once the node
is back). Nothing changed, nothing is sent but keep-alive comments.
Ages (`…SecsAgo`, `secsAgo`, `uptimeSecs`, `dormantForSecs`,