aboutsummaryrefslogtreecommitdiffstats
path: root/docs/openapi.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/openapi.yaml')
-rw-r--r--docs/openapi.yaml8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 57ef132..349f943 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1529,13 +1529,15 @@ paths:
What counts, as the store reads now (docs/federation.md): the current version
(its number, its hash, and the version itself), each party's keys and nodes, 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
- (`proposals`) and of the votes on it (`votes`), the parties voting `true` (`yes`)
+ 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
+ its heads) and of the votes on it (`votes`), the parties voting `true` (`yes`)
and `false` (`no`), whether it passed (`passed`: two thirds of the parties voted
`true`) and whether it is dead (`dead`: so many voted `false` that the rest can't
pass it), and why a party's client backs it not (`none`), where it is no version,
none changing the current one, or one naming the heads of the current one's
- checkpoint, as this node reads it: one that passed all the same is never written,
+ checkpoint, as this node reads it, or no event proposing it is above the heads it
+ names: one that passed all the same is never written,
or, no version here, this node stops at its version event. A passed proposal is
written at once, and lapses with the rest.
responses: