aboutsummaryrefslogtreecommitdiffstats
path: root/docs/openapi.yaml
diff options
context:
space:
mode:
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: