summaryrefslogtreecommitdiffstats
path: root/docs/openapi.yaml
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 13:34:24 +0000
committertv <tv@krebsco.de>2026-11-19 14:39:54 +0100
commit9164ebfe9a4014cbbaaaff90c5a1d722e39457fd (patch)
tree9a45156bd4919054939d12c97a19672e92e07b98 /docs/openapi.yaml
parent7a5aeb02024ddff71ba60f40913555cd21a633ad (diff)
federation: which nodes know a revision, in counts and before a `true`
`GET /events/counts` says, of each node a party lists, what it said it speaks and knows (`knows`, by node ID): the wire versions, the oldest and the newest, and the newest revision of the federation it knows, by number and ID and as people read it, its number null where this continuum doesn't know it; null where it said nothing, a build from before SPEAKS or one the node didn't hear from; the node's own as it is. So the nodes still to upgrade before a revision passes show, every party's, where before a party's operators could check only their own. A party's client, backing a proposal that moves to another revision, warns of every node of any party not known to know it, a line a party naming each and what it said: once it passes, those stop at it till upgraded. `next` warns alike, of the revision it moves to, or of the later one it suggests. A warning, not a refusal: what a node heard is no proof, and a node not heard from may well be upgraded.
Diffstat (limited to 'docs/openapi.yaml')
-rw-r--r--docs/openapi.yaml39
1 files changed, 38 insertions, 1 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 05e29d5..b1e1e28 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1550,7 +1550,12 @@ paths:
description: |
What counts, as the store reads now (docs/federation.md): the current version
(its number, its hash, its revision, by number and ID and as people read it, and
- the version itself), each party's keys and nodes, the
+ the version itself), each party's keys and nodes, what each of those nodes said
+ it speaks and knows (`knows`, by node ID: the wire versions it speaks, the oldest
+ and the newest, and the newest revision of the federation it knows, by number
+ and ID and as people read it, its number null where this node doesn't know it;
+ null where the node said nothing, a build from before SPEAKS or one this node
+ didn't hear from; this node's own as it is), the
value at each place, the members, each `[node, party]`, and the proposals on the
current version, by their hash, each with the IDs of the events proposing it that
a vote may build on (`proposals`: of a version naming a checkpoint, those above
@@ -1576,6 +1581,38 @@ paths:
type: object
parties:
type: object
+ additionalProperties:
+ type: object
+ required: [keys, nodes, knows]
+ properties:
+ keys:
+ type: array
+ items:
+ type: string
+ nodes:
+ type: array
+ items:
+ type: string
+ knows:
+ type: object
+ additionalProperties:
+ type: [object, 'null']
+ required: [wire, revision]
+ properties:
+ wire:
+ type: array
+ items:
+ type: integer
+ revision:
+ type: [object, 'null']
+ required: [number, id, named]
+ properties:
+ number:
+ type: [integer, 'null']
+ id:
+ type: string
+ named:
+ type: string
values:
type: object
members: