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

improved documentation on statuses links and values

Browse Source
This commit is contained in:
diminator 2017-01-12 16:48:58 +01:00 committed by tim
parent 7d5d79a50c
commit d68d70ebc3
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -248,14 +248,12 @@ Statuses
Supports the retrieval of a status for a transaction using ``tx_id`` or the
retrieval of a status for a block using ``block_id``. Only use exactly one of both
queries, as they are required but mutually exclusive.
queries, as they are required but mutually exclusive. A URL to the resource is also
provided under ``_links``.
The possible status values are ``backlog``, ``undecided``, ``valid`` or
``invalid``.
If a transaction or block is persisted to the chain and it's status is set
to ``valid`` or ``undecided``, a ``200`` status code is returned,
as well as an URL to the resource.
The possible status values are ``undecided``, ``valid`` or
``invalid`` for both blocks and transactions. An additional state ``backlog`` is provided
for transactions.
:param tx_id: transaction ID
:type tx_id: hex string