aboutsummaryrefslogtreecommitdiffstats
path: root/docs/openapi.yaml
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-07 22:35:10 +0100
committertv <tv@krebsco.de>2026-11-07 22:35:10 +0100
commit0e03a77bcb1d39f1fbda23d8e704ac40302afb93 (patch)
tree79245416e9721cdccb1b6879b8f1cfc43629cc74 /docs/openapi.yaml
parentc016fc783ff29e9069a446e17876046df64760a8 (diff)
dashboard: without LINKS; LINKS removed
The dashboard reads every member's links from the members themselves; LINKS and LINKS_REPLY, swarm::links and their wire tags go (wire version bumped). Nodes the browser can't reach are drawn from what the reachable ones measure. Auth plan M3.
Diffstat (limited to 'docs/openapi.yaml')
-rw-r--r--docs/openapi.yaml38
1 files changed, 7 insertions, 31 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 20cbf80..4b82ff7 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -992,20 +992,18 @@ paths:
The dashboard's latest snapshot: `node` (`id`, `alias`), `page` (the page's
version, a hash: a page showing another reloads), `stats` (as
`/admin/stats`), `peers` (as `/peers`) and `graph`: `members` (by node ID,
- those of the member list, and any a link reported goes to: `alias`, `self`,
+ those of the member list, and any of this node's links goes to: `alias`, `self`,
`dashboard`: its `--dashboard-url`), `intended` (by node ID: the neighbours the member list gives
- it, as this node computes them), `measured` (by node ID: `secsAgo`, `epoch`
- (the epoch the member said it is in: `generation`, `id`) 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) and `live` (whether the
- members' links are subscribed to, `/admin/dashboard/links`), and `remakes`
+ it, as this node computes them) and `measured` (this node's own, by its node ID:
+ `secsAgo`, `epoch` (`generation`, `id`) and `links`, each with `peer`, `transport`, `relayed`, `down`, `rttMs`, `dormant`, `clock` and
+ `others` (the peer's other transports: `transport`, `rttMs`, `relayed`); other
+ nodes' the page reads from them, `/admin/dashboard/links/own/events`), and `remakes`
(those of this node's epoch: `id`, `coordinator`, `phase` as in
`/admin/remakes`, `voters` (node IDs), `fromGeneration`, the epoch's, and
once committed `switchDelayMs` and `switchInMs`, this node's wait to switch
and what is left of it). 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.
+ request); every client gets the same. Only with the `dashboard` cargo feature.
responses:
'200':
description: The snapshot.
@@ -1076,30 +1074,11 @@ paths:
summary: Dashboard refresh
description: |
The dashboard's producer builds the state now rather than at its next tick, and
- asks the members for their links again; what changed comes as events. Only with
+ computes the member list's graph again; what changed comes as events. Only with
the `dashboard` cargo feature.
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/tree:
get:
tags: [Admin]
@@ -2075,9 +2054,6 @@ components:
paths:
$ref: '#/components/schemas/Counter'
description: PING and PONG; the paths layer's own PINGs counted under the address (so only in the totals).
- links:
- $ref: '#/components/schemas/Counter'
- description: LINKS and LINKS_REPLY, asked for and answered for a map of the swarm (the dashboard).
probe:
$ref: '#/components/schemas/Counter'
description: PROBE and PROBE_REPLY, asking others whether they reach a member before recording a link to it as unreached.