From 8afedcc3287d72a3674a42cfde7a2c1e6bda5b09 Mon Sep 17 00:00:00 2001 From: Cofson Date: Tue, 23 Dec 2025 18:45:41 +0100 Subject: [PATCH] Add Checkpoint Provider HTTP API section with OpenAPI spec --- nomos/raw/cryptarchia-v1-bootstr-sync.md | 29 ++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/nomos/raw/cryptarchia-v1-bootstr-sync.md b/nomos/raw/cryptarchia-v1-bootstr-sync.md index e752ebb..09cb415 100644 --- a/nomos/raw/cryptarchia-v1-bootstr-sync.md +++ b/nomos/raw/cryptarchia-v1-bootstr-sync.md @@ -427,10 +427,31 @@ Upon restart, it can use this timestamp to calculate how long it has been offlin ### Checkpoint Provider HTTP API -> **TODO**: This section is referenced in the source document -> but not yet defined. -> Content to be added describing the HTTP API -> for downloading checkpoint blocks and ledger state. +A trusted checkpoint provider serves the `GET /checkpoint` API, +allowing users (which are not connected via p2p) +to download the latest checkpoint block and its corresponding ledger state. + +```yaml +openapi: 3.0 + +paths: + /checkpoint: + get: + responses: + '200': + description: OK + content: + multipart/mixed: + schema: + type: object + properties: + checkpoint_block: + type: string + format: binary + checkpoint_ledger_state: + type: string + format: binary +``` ## References