aboutsummaryrefslogtreecommitdiffstats
path: root/docs/openapi.yaml
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-17 16:21:09 +0000
committertv <tv@krebsco.de>2026-11-17 17:36:16 +0100
commit1bbb45bfe7c9c437373aefa08a6a985bc260f520 (patch)
tree5c17d68c431de24e123d32abb71c9b27377708db /docs/openapi.yaml
parent7fc844ff0167fb0943e3fa85af671d8f3bbf005d (diff)
events: the store's summary names the node's party, and whether it votes for it
`GET /events` names the party the node is of (`party`, `--store-party`) and whether it votes for it by itself (`votesByItself`, `--store-vote-key`), and so casts a vote by hand (`POST /admin/events/vote`): what a page offering votes through the node asks.
Diffstat (limited to 'docs/openapi.yaml')
-rw-r--r--docs/openapi.yaml10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 789ee6c..5cffccf 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1418,7 +1418,9 @@ paths:
description: |
The store's ID (its root's), its checkpoint's ID, its heads (what a new event
builds on) and how many events it took after its checkpoint, as this node reads
- it now.
+ it now; the party this node is of (`party`, `--store-party`), and whether it
+ votes for it by itself (`votesByItself`), and so casts votes by hand
+ (`POST /admin/events/vote`).
responses:
'200':
description: The store.
@@ -1426,7 +1428,7 @@ paths:
application/json:
schema:
type: object
- required: [store, checkpoint, heads, taken]
+ required: [store, checkpoint, heads, taken, party, votesByItself]
properties:
store:
type: string
@@ -1438,6 +1440,10 @@ paths:
type: string
taken:
type: integer
+ party:
+ type: [string, 'null']
+ votesByItself:
+ type: boolean
'404':
$ref: '#/components/responses/Error'
post: