From b8975ccff60a942a22c3ae4cc6b0493265db0715 Mon Sep 17 00:00:00 2001 From: Thane Thomson Date: Wed, 30 Nov 2022 07:33:18 -0500 Subject: [PATCH] docs: Expand on genesis_chunked description (#9793) Signed-off-by: Thane Thomson Signed-off-by: Thane Thomson --- rpc/openapi/openapi.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/rpc/openapi/openapi.yaml b/rpc/openapi/openapi.yaml index 495cd028d..13c0c456a 100644 --- a/rpc/openapi/openapi.yaml +++ b/rpc/openapi/openapi.yaml @@ -918,8 +918,10 @@ paths: tags: - Info description: | - Get genesis document in multiple chunks to make it - easier to iterate through larger genesis structures. + Get genesis document in multiple chunks to make it easier to iterate + through larger genesis structures. Each chunk is produced by converting + the genesis document to JSON and then splitting the resulting payload + into 16MB blocks, and then Base64-encoding each block. Upon success, the `Cache-Control` header will be set with the default maximum age. @@ -933,7 +935,7 @@ paths: example: 1 responses: "200": - description: Genesis results. + description: Genesis chunk response. content: application/json: schema: