Dev Docs: minor edits to 0.13.x REST API update

This commit is contained in:
David A. Harding 2017-01-02 19:40:41 -05:00 committed by Michael Rotarius
parent 8a93b97ce9
commit 3ded57ca91
5 changed files with 9 additions and 8 deletions

View file

@ -85,7 +85,7 @@ GET /block/notxdetails/<hash>.<format>
- n: "→<br>`versionHex`" - n: "→<br>`versionHex`"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.13.0*<br><br>This block's version number formatted in hexadecimal" d: "*Added in Bitcoin Core 0.13.0*<br><br>This block's version number formatted in hexadecimal. See [BIP9 assignments][]"
- n: "→<br>`merkleroot`" - n: "→<br>`merkleroot`"
t: "string (hex)" t: "string (hex)"

View file

@ -88,7 +88,7 @@ GET /block/<hash>.<format>
- n: "→<br>`versionHex`" - n: "→<br>`versionHex`"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.13.0*<br><br>This block's version number formatted in hexadecimal" d: "*Added in Bitcoin Core 0.13.0*<br><br>This block's version number formatted in hexadecimal. See [BIP9 assignments]"
- n: "→<br>`merkleroot`" - n: "→<br>`merkleroot`"
t: "string (hex)" t: "string (hex)"

View file

@ -35,7 +35,7 @@ GET /getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>
- n: "Outpoint" - n: "Outpoint"
t: "vector" t: "vector"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "The list of outpoints to be queried. Each outpoint is the TXID of the transaction, encoded as hex in RPC byte order with an addditional `-n`" d: "The list of outpoints to be queried. Each outpoint is the TXID of the transaction, encoded as hex in RPC byte order with an additional `-n` parameter for the output index (vout) number, with the index starting from 0"
{% enditemplate %} {% enditemplate %}
@ -55,7 +55,7 @@ GET /getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>
- n: "`result`" - n: "`result`"
t: "object" t: "object"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The requetsted UTXO set" d: "The requested UTXO set"
- n: "→→<br>`chainHeight`" - n: "→→<br>`chainHeight`"
t: "number (int)" t: "number (int)"
@ -70,7 +70,7 @@ GET /getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>
- n: "→<br>`bitmap`" - n: "→<br>`bitmap`"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "" d: "Whether each requested output was found in the UTXO set or not. A `1` is returned for those that were found and a `0` is returned for those that were not found. Results are returned in the same order as outpoints were requested in the input parameters"
- n: "→<br>`utxos`" - n: "→<br>`utxos`"
t: "array" t: "array"
@ -186,4 +186,4 @@ Result (whitespaced added):
* [GetTxOutSetInfo][rpc gettxoutsetinfo] RPC: {{summary_getTxOutSetInfo}} * [GetTxOutSetInfo][rpc gettxoutsetinfo] RPC: {{summary_getTxOutSetInfo}}
{% endautocrossref %} {% endautocrossref %}

View file

@ -7,7 +7,7 @@ http://opensource.org/licenses/MIT.
##### GET Headers ##### GET Headers
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
{% assign summary_restGetHeaders="returns a specified amout of block headers in upward direction." %} {% assign summary_restGetHeaders="returns a specified amount of block headers in upward direction." %}
{% autocrossref %} {% autocrossref %}
@ -85,7 +85,7 @@ GET /headers/<count>/<hash>.<format>
- n: "→→<br>`versionHex`" - n: "→→<br>`versionHex`"
t: "string (hex)" t: "string (hex)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.13.0*<br><br>This block's version number formatted in hexadecimal" d: "*Added in Bitcoin Core 0.13.0*<br><br>This block's version number formatted in hexadecimal. See [BIP9 assignments][]"
- n: "→→<br>`merkleroot`" - n: "→→<br>`merkleroot`"
t: "string (hex)" t: "string (hex)"

View file

@ -291,6 +291,7 @@ http://opensource.org/licenses/MIT.
{% comment %}<!-- Official reference documents (BIPs should not use zero padding: {% comment %}<!-- Official reference documents (BIPs should not use zero padding:
BIP32 not BIP0032); alphabetical order -->{% endcomment %} BIP32 not BIP0032); alphabetical order -->{% endcomment %}
[BIP9]: https://github.com/bitcoin/bips/blob/master/bip-0009.mediawiki [BIP9]: https://github.com/bitcoin/bips/blob/master/bip-0009.mediawiki
[BIP9 assignments]: https://github.com/bitcoin/bips/blob/master/bip-0009/assignments.mediawiki
[BIP14]: https://github.com/bitcoin/bips/blob/master/bip-0014.mediawiki [BIP14]: https://github.com/bitcoin/bips/blob/master/bip-0014.mediawiki
[BIP16]: https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki [BIP16]: https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki
[BIP21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki [BIP21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki