diff options
Diffstat (limited to 'docs/openapi.yaml')
| -rw-r--r-- | docs/openapi.yaml | 40 |
1 files changed, 28 insertions, 12 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 3dbcd62..e1e602a 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -1419,9 +1419,12 @@ 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; 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`). + it now; the event it stopped at, if any (`stopped`: a version event writing a + version that passed, which this continuum doesn't read), why, and how many + events it holds back since, that one among them, taking nothing and refusing + nothing until upgraded or told to drop it (`/admin/events/drop`); 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. @@ -1429,7 +1432,7 @@ paths: application/json: schema: type: object - required: [store, checkpoint, heads, taken, party, votesByItself] + required: [store, checkpoint, heads, taken, stopped, party, votesByItself] properties: store: type: string @@ -1441,6 +1444,16 @@ paths: type: string taken: type: integer + stopped: + type: [object, 'null'] + required: [id, why, heldBack] + properties: + id: + type: string + why: + type: string + heldBack: + type: integer party: type: [string, 'null'] votesByItself: @@ -1454,7 +1467,8 @@ paths: Puts an event, the body as its bytes, whoever signed it: offered to the store, and written into the document at its ID (the SHA-256 of its bytes) unless the store refuses it. `event` says what became of it: `taken`, `held` (taken - before), or `waiting` for what it builds on. + before), `waiting` for what it builds on, or `stopped`: held back, the store + stopped at a version it doesn't read (`stopped` in `GET /events`). requestBody: required: true content: @@ -1474,7 +1488,7 @@ paths: type: string event: type: string - enum: [taken, held, waiting] + enum: [taken, held, waiting, stopped] '404': $ref: '#/components/responses/Error' '422': @@ -1680,12 +1694,14 @@ paths: tags: [Events] summary: Drop events this node took description: | - Drops events the store took after its checkpoint, version events naming the - version one of them names, and everything built on them: this node refuses them - from then on, from whoever brings them, and any version event naming a version - among them, and keeps so across restarts (`--store-file`), until it is told - otherwise (`/admin/events/allow`). Not what the checkpoint keeps or holds by - ID. Answers what it dropped, in the order taken. Needs `write` on `_continuum`. + Drops events the store took after its checkpoint, or the version event it + stopped at (`stopped` in `GET /events`), version events naming the version one + of them names, and everything built on them: this node refuses them from then + on, from whoever brings them, and any version event naming a version among + them, and keeps so across restarts (`--store-file`), until it is told otherwise + (`/admin/events/allow`). Not what the checkpoint keeps or holds by ID. Answers + what it dropped, in the order taken, then the event it stopped at, after which + it takes again. Needs `write` on `_continuum`. requestBody: required: true content: |
