7f20eb5f8e
* generate RPC docs using Slate (#691) * update changelog * skip if branch not develop * slate: only build if rpc/core has changes * fetch develop to compare against * slate: build on master only * [rpc/core] use original repo, not fork in README |
||
|---|---|---|
| .. | ||
| types | ||
| README.md | ||
| abci.go | ||
| blocks.go | ||
| consensus.go | ||
| dev.go | ||
| doc.go | ||
| doc_template.txt | ||
| events.go | ||
| health.go | ||
| mempool.go | ||
| net.go | ||
| pipe.go | ||
| pipe_test.go | ||
| routes.go | ||
| status.go | ||
| tx.go | ||
| version.go | ||
README.md
Tendermint RPC
Generate markdown for Slate
We are using Slate to power our RPC documentation. For generating markdown use:
go get github.com/davecheney/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$'
For more information see the CI script for building the Slate docs
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.