Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Dev Docs: Add REST Documentation #720

Merged
merged 2 commits into from Jan 27, 2015

Conversation

Projects
None yet
3 participants
Contributor

harding commented Jan 26, 2015

Preview: http://dg1.dtrt.org/en/developer-reference#http-rest

This adds documentation for the new REST API in Bitcoin Core 0.10.0. It uses the same formating we use for the JSON-RPC documentation with the section headings formatting based on Twitter's REST docs. (As this is the first REST docs I've written, I looked for examples and liked theirs the most.)

Feedback on content or formatting appreciated.

CC: @jlopp (requested docs in issue #715), @jonasschnelli (did a lot of work on the REST interface)

Dev Docs: Add REST Documentation
* Uses same basic format as JSON-RPC documentation.

Closes #715

@harding harding added the Dev Docs label Jan 26, 2015

Contributor

jonasschnelli commented Jan 26, 2015

Nice work!

  • Would it make sense to mention that -txindex needs a -reindex=1? Because from time to time there are question like this: bitcoin/bitcoin#5667.
  • Maybe it would be good to tell the users once again that they should NOT allow public access to the bitcoind http/rest server

ACK.

Contributor

harding commented Jan 26, 2015

@jonasschnelli good ideas! I'll make both those changes momentarily. Thanks for your review!

Contributor

jlopp commented Jan 26, 2015

ACK

Dev Docs: REST: Add Security Note & Reindex Note
Added both notes to both JSON-RPC and REST docs.

Suggested by Jonas Schnelli (thanks!)
Contributor

harding commented Jan 26, 2015

Commit 73eb097 adds both notes suggested by @jonasschnelli, adding them to the relevant parts of both the REST and JSON-RPC docs. Preview updated.

In the absence of critical feedback, this pull will be merged around 20:00 UTC Tuesday.

@harding harding merged commit 73eb097 into bitcoin-dot-org:master Jan 27, 2015

@harding harding deleted the harding:restapi branch Feb 25, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment