diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/openapi.yaml | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 1f3a71a..35b9b2b 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -546,10 +546,11 @@ paths: version, a hash: a page showing another reloads), `stats` (as `/admin/stats`), `peers` (as `/peers`) and `graph`: `members` (by node ID: `alias`, `self`), `intended` (by node ID: the neighbours the member list gives - it, as this node computes them) and `measured` (by node ID: `secsAgo` and + it, as this node computes them), `measured` (by node ID: `secsAgo` and `links`, each with `peer`, `transport`, `relayed`, `down`, `rttMs`, `dormant` and `others` (the peer's other transports: `transport`, `rttMs`, `relayed`), as the member - answered a LINKS; ours always, the others' while fresh). One producer + answered a LINKS; ours always, the others' while fresh) and `live` (whether the + members' links are subscribed to, `/admin/dashboard/links`). One producer per node makes it every 2 s while anyone looks (and for a minute after this request), subscribed to the members' links (each tells of a change as it happens; renewed every 30 s); every client gets the same. Only with the `dashboard` cargo feature. @@ -573,6 +574,25 @@ paths: responses: '204': description: Done. + /admin/dashboard/links: + post: + tags: [Admin] + summary: Dashboard links, live or asked + description: | + Whether the dashboard's producer subscribes to the members' links (`live=true`, + the default: each member tells of a change as it happens) or only asks for them + every 30 s (`live=false`: fewer messages in the swarm, a map up to 30 s + behind). For every client of this node, until set again or the node restarts; + the state's `graph.live` says which. Only with the `dashboard` cargo feature. + parameters: + - name: live + in: query + required: true + schema: + type: boolean + responses: + '204': + description: Done. /admin/dashboard/events: get: tags: [Admin] |