docs: fix RPC output examples for GET queries (#7799)

Remove JSON-RPC wrappers from GET output, since they are no longer printed.
Also format examples with jq so they look a little neater.

Fixes #7779.

Co-authored-by: William Banfield <4561443+williambanfield@users.noreply.github.com>
This commit is contained in:
M. J. Fromberger
2022-02-10 15:49:32 -08:00
committed by GitHub
parent 7885839b75
commit ef1cc5b516
5 changed files with 86 additions and 95 deletions

View File

@@ -23,7 +23,7 @@ yourself with the syntax.
By following along with this guide, you'll create a Tendermint Core project
called kvstore, a (very) simple distributed BFT key-value store.
> Note: please use a released version of Tendermint with this guide. The guides will work with the latest version. Please, do not use master.
> Note: please use a released version of Tendermint with this guide. The guides will work with the latest version. Please, do not use master.
## Built-in app vs external app
@@ -57,7 +57,7 @@ go mod init github.com/<github_username>/<repo_name>
Inside the example directory create a `main.go` file with the following content:
> Note: there is no need to clone or fork Tendermint in this tutorial.
> Note: there is no need to clone or fork Tendermint in this tutorial.
```go
package main
@@ -642,16 +642,13 @@ Now open another tab in your terminal and try sending a transaction:
```bash
$ curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'
{
"jsonrpc": "2.0",
"id": "",
"result": {
"check_tx": {
"gasWanted": "1"
},
"deliver_tx": {},
"hash": "1B3C5A1093DB952C331B1749A21DCCBB0F6C7F4E0055CD04D16346472FC60EC6",
"height": "128"
}
"check_tx": {
"gasWanted": "1",
...
},
"deliver_tx": { ... },
"hash": "1B3C5A1093DB952C331B1749A21DCCBB0F6C7F4E0055CD04D16346472FC60EC6",
"height": "128"
}
```
@@ -662,14 +659,16 @@ Now let's check if the given key now exists and its value:
```json
$ curl -s 'localhost:26657/abci_query?data="tendermint"'
{
"jsonrpc": "2.0",
"id": "",
"result": {
"response": {
"log": "exists",
"key": "dGVuZGVybWludA==",
"value": "cm9ja3M="
}
"response": {
"code": 0,
"log": "exists",
"info": "",
"index": "0",
"key": "dGVuZGVybWludA==",
"value": "cm9ja3M=",
"proofOps": null,
"height": "6",
"codespace": ""
}
}
```

View File

@@ -526,17 +526,15 @@ I[2019-07-16|18:26:20.330] Accepted a new connection
Now open another tab in your terminal and try sending a transaction:
```json
curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'
$ curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'
{
"jsonrpc": "2.0",
"id": "",
"result": {
"check_tx": {
"gasWanted": "1"
},
"deliver_tx": {},
"hash": "CDD3C6DFA0A08CAEDF546F9938A2EEC232209C24AA0E4201194E0AFB78A2C2BB",
"height": "33"
"check_tx": {
"gasWanted": "1",
...
},
"deliver_tx": { ... },
"hash": "CDD3C6DFA0A08CAEDF546F9938A2EEC232209C24AA0E4201194E0AFB78A2C2BB",
"height": "33"
}
```
@@ -545,16 +543,18 @@ Response should contain the height where this transaction was committed.
Now let's check if the given key now exists and its value:
```json
curl -s 'localhost:26657/abci_query?data="tendermint"'
$ curl -s 'localhost:26657/abci_query?data="tendermint"'
{
"jsonrpc": "2.0",
"id": "",
"result": {
"response": {
"log": "exists",
"key": "dGVuZGVybWludA==",
"value": "cm9ja3My"
}
"response": {
"code": 0,
"log": "exists",
"info": "",
"index": "0",
"key": "dGVuZGVybWludA==",
"value": "cm9ja3M=",
"proofOps": null,
"height": "6",
"codespace": ""
}
}
```