Dev Docs: Add REST Documentation #720
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Uses same basic format as JSON-RPC documentation. Closes bitcoin-dot-org#715
|
Nice work!
ACK. |
|
@jonasschnelli good ideas! I'll make both those changes momentarily. Thanks for your review! |
|
ACK |
Added both notes to both JSON-RPC and REST docs. Suggested by Jonas Schnelli (thanks!)
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)