rpc: update docs (backport #9674) (#9791)

* rpc: update docs (#9674)

Closes issue [#9522](https://github.com/tendermint/tendermint/issues/9522) by adding genesis chunked to the rpc docs

(cherry picked from commit 4290ad2982)

* docs: Expand on genesis_chunked description

Signed-off-by: Thane Thomson <connect@thanethomson.com>

Signed-off-by: Thane Thomson <connect@thanethomson.com>
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
Co-authored-by: Thane Thomson <connect@thanethomson.com>
This commit is contained in:
mergify[bot]
2022-11-29 17:38:41 -05:00
committed by GitHub
parent 53aaf55f9f
commit e9bbf60713
2 changed files with 65 additions and 1 deletions

View File

@@ -1,3 +1,3 @@
#!/bin/bash
cp -a ../rpc/openapi/ .vuepress/public/rpc/
cp -a ../rpc/openapi/* .vuepress/public/rpc/

View File

@@ -880,6 +880,41 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/genesis_chunked:
get:
summary: Get Genesis in multiple chunks
operationId: genesis_chunked
tags:
- Info
description: |
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.
parameters:
- in: query
name: chunk
description: Sequence number of the chunk to download.
schema:
type: integer
default: 0
example: 1
responses:
"200":
description: Genesis chunk response.
content:
application/json:
schema:
$ref: "#/components/schemas/GenesisChunkedResponse"
"500":
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/dump_consensus_state:
get:
summary: Get consensus state
@@ -1935,6 +1970,35 @@ components:
properties: {}
type: object
GenesisChunkedResponse:
type: object
required:
- "jsonrpc"
- "id"
- "result"
properties:
jsonrpc:
type: string
example: "2.0"
id:
type: integer
example: 0
result:
required:
- "chunk"
- "total"
- "data"
properties:
chunk:
type: integer
example: 0
total:
type: integer
example: 1
data:
type: string
example: "Z2VuZXNpcwo="
DumpConsensusResponse:
type: object
required: