History

Ethan Buchman 6f9867cba6 fix validate pagination params		2018-05-20 01:47:15 -04:00
..
types	limit /tx_search output	2018-05-17 21:25:03 +04:00
README.md	limit /tx_search output	2018-05-17 21:25:03 +04:00
abci.go	Fix `Prove` int abci.ABCIQuery (#1485 )	2018-04-24 09:56:25 +02:00
blocks.go	final updates for state	2017-12-28 23:15:54 -05:00
consensus.go	fixes from review	2018-05-14 10:33:31 -04:00
dev.go	linting: apply errcheck part1	2017-11-27 22:39:11 +00:00
doc.go	Add `\health` rpc endpoint (#1306 )	2018-03-19 19:39:37 +03:00
doc_template.txt	generate md for Slate	2017-08-16 15:17:08 -04:00
events.go	WIP: fix rpc/core	2018-04-05 16:07:29 -07:00
health.go	fix comment	2018-03-19 20:01:43 +03:00
mempool.go	add limit param to /unconfirmed_txs	2018-05-17 21:25:04 +04:00
net.go	rpc: add n_peers to /net_info	2018-04-28 16:09:18 -04:00
pipe.go	fix validate pagination params	2018-05-20 01:47:15 -04:00
pipe_test.go	fix validate pagination params	2018-05-20 01:47:15 -04:00
routes.go	add limit param to /unconfirmed_txs	2018-05-17 21:25:04 +04:00
status.go	rpc: docs/comments	2018-04-27 23:19:40 -04:00
tx.go	fix validate pagination params	2018-05-20 01:47:15 -04:00
version.go	rpc -> rpc/lib and rpc/tendermint -> rpc	2017-04-26 19:57:33 -04:00

README.md

Tendermint RPC

Generate markdown for Slate

We are using Slate to power our RPC documentation. If you are changing a comment, make sure to copy the resulting changes to the slate repo and make a PR there as well. For generating markdown use:

go get github.com/melekes/godoc2md

godoc2md -template rpc/core/doc_template.txt github.com/tendermint/tendermint/rpc/core | grep -v -e "pipe.go" -e "routes.go" -e "dev.go" | sed 's$/src/target$https://github.com/tendermint/tendermint/tree/master/rpc/core$'

Pagination

Requests that return multiple items will be paginated to 30 items by default. You can specify further pages with the ?page parameter. You can also set a custom page size up to 100 with the ?per_page parameter.