Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation about transactions endpoint. (#1360)

Browse Source 
* Fixed documentation about transactions endpoint.

* clarify how bigchaindb handles invalid transactions

* rephrase
This commit is contained in:
Rodolphe Marques
2017-04-04 11:25:26 +02:00
committed by GitHub
parent 9f5e6d5450
commit 6f916d5781
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/server/source/drivers-clients/http-client-server-api.rst
View File

@@ -46,8 +46,12 @@ Transactions
Get the transaction with the ID ``tx_id``.
This endpoint returns a transaction only if a ``VALID`` block on
``bigchain`` exists.
This endpoint returns a transaction if it was included in a ``VALID`` block,
if it is still waiting to be processed (``BACKLOG``) or is still in an
undecided block (``UNDECIDED``). All instances of a transaction in invalid
blocks are ignored and treated as if they don't exist. If a request is made
for a transaction and instances of that transaction are found only in
invalid blocks, then the response will be ``404 Not Found``.
:param tx_id: transaction ID
:type tx_id: hex string