diff options
Diffstat (limited to 'docs/openapi.yaml')
| -rw-r--r-- | docs/openapi.yaml | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml index b863553..5ccafb8 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -521,8 +521,11 @@ paths: `/admin/dashboard/state`) first, then a `patch` event (a JSON merge patch, RFC 7386, onto the state before) whenever something but ages changed, at most every 2 s. Each event's ID is its number. A client that falls behind gets a - `snapshot` again. 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. + `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 + 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`, `observedSecs`, `lastFromNeighbourSecs`, `oldestQuarantineSecs`) are as of the event: they alone changing sends nothing, the client counts them on. Only with the |