aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2019-01-21 17:37:18 +0100
committerWladimir J. van der Laan <laanwj@gmail.com>2019-01-21 17:37:55 +0100
commit72506ed3491d9bf9087f2b0b321952d93de50b64 (patch)
tree54a64b687b1fc375880b100429f7280951c28bc0 /doc
parent9fa2b89ed1d73c95d7b37d12b33b375e8164d05b (diff)
parent7cf994d5cfd53dcff76ebd0e0007e3477a7570e8 (diff)
downloadbitcoin-72506ed3491d9bf9087f2b0b321952d93de50b64.tar.xz
Merge #15177: rest: Improve tests and documention of /headers and /block
7cf994d5cfd53dcff76ebd0e0007e3477a7570e8 qa: Improve tests of /rest/headers and /rest/block (João Barbosa) 0825b86b280c684c32c60bac9e862298c7279f27 doc: /rest/block responds with 404 if block does not exist (João Barbosa) be625f7c5562afed517ff51d2d85268ba5ce6017 doc: Explain empty result of /rest/headers (João Barbosa) Pull request description: Follow up of #15107. Tree-SHA512: a7fdeed05216e3eda9604664db529237c2d0ddf422cfac139d6345a22b6e00bfe870d4e3f177423db7d4efb295ac2dc0ca2eb20c9c27c0719b89fd5428860d03
Diffstat (limited to 'doc')
-rw-r--r--doc/REST-interface.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index 44df698382..ff7ef6ce1c 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -27,6 +27,7 @@ For full TX query capability, one must enable the transaction index via "txindex
`GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json>`
Given a block hash: returns a block, in binary, hex-encoded binary or JSON formats.
+Responds with 404 if the block doesn't exist.
The HTTP request and response are both handled entirely in-memory, thus making maximum memory usage at least 2.66MB (1 MB max block, plus hex encoding) per request.
@@ -36,6 +37,7 @@ With the /notxdetails/ option JSON response will only contain the transaction ha
`GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex|json>`
Given a block hash: returns <COUNT> amount of blockheaders in upward direction.
+Returns empty if the block doesn't exist or it isn't in the active chain.
#### Chaininfos
`GET /rest/chaininfo.json`