aboutsummaryrefslogtreecommitdiffstats
path: root/docs/openapi.yaml
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 21:45:11 +0000
committertv <tv@krebsco.de>2026-11-16 23:07:29 +0100
commit0c213626ba238fd6d8d69d08475d57e486f6f27a (patch)
treecee091c61ef3fd9505a04eaadba482785f422a1e /docs/openapi.yaml
parentd893a092c469688eaf98c98725fedf6dfad99614 (diff)
api: what counts names the proposals on the current version, and their votes
A party's client votes by the record it keeps, and keeps the votes that made its party's earlier proposal dead; it reads them from a node, and checks them itself, as each is signed. `GET /events/counts` names the proposals on the current version, by their hash, each with the events proposing it and the votes on it, by ID (`State::ballots`).
Diffstat (limited to 'docs/openapi.yaml')
-rw-r--r--docs/openapi.yaml20
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 0bce165..c8f839c 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1507,7 +1507,9 @@ paths:
description: |
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, and the members, each `[node, party]`.
+ 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`).
responses:
'200':
description: What counts.
@@ -1515,7 +1517,7 @@ paths:
application/json:
schema:
type: object
- required: [version, parties, values, members]
+ required: [version, parties, values, members, proposals]
properties:
version:
type: object
@@ -1529,6 +1531,20 @@ paths:
type: array
items:
type: string
+ proposals:
+ type: object
+ additionalProperties:
+ type: object
+ required: [proposals, votes]
+ properties:
+ proposals:
+ type: array
+ items:
+ type: string
+ votes:
+ type: array
+ items:
+ type: string
'404':
$ref: '#/components/responses/Error'
/events/refused: