You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Ethan Buchman f2349b1092 Merge pull request #526 from tendermint/feature/rpc-docs 7 years ago
..
types First crack it providing fast-sync endpoint 8 years ago
README.md rpc: typo fixes 7 years ago
abci.go wrote docs for rpc methods [ci skip] 7 years ago
blocks.go wrote docs for rpc methods [ci skip] 7 years ago
consensus.go wrote docs for rpc methods [ci skip] 7 years ago
dev.go remove viper from rpc except test 8 years ago
doc.go rpc: typo fixes 7 years ago
doc_template.txt generate md for Slate 7 years ago
events.go rpc: typo fixes 7 years ago
mempool.go wrote docs for rpc methods [ci skip] 7 years ago
net.go wrote docs for rpc methods [ci skip] 7 years ago
pipe.go comments 7 years ago
routes.go [rpc] dont enable unsafe by default; limit /blockchain_info to 20 blocks 8 years ago
status.go Merge pull request #526 from tendermint/feature/rpc-docs 7 years ago
tx.go rpc: typo fixes 7 years ago
version.go bump rpc version; add consensus version 9 years ago

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$'