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

tx_id --> txid

Browse Source
This commit is contained in:
tim 2016-11-16 12:23:54 +01:00
parent 5789a37664
commit b488997353
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -71,10 +71,10 @@ POST /transactions/
GET /statuses/2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e GET /statuses/2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e
-------------------------------- --------------------------------
.. http:get:: /statuses/{tx_id} .. http:get:: /statuses/{txid}
Get the status of a transaction with the ID ``tx_id``, if a transaction Get the status of a transaction with the ID ``txid``, if a transaction
with that ``tx_id`` exists. with that ``txid`` exists.
The possible status values are ``backlog``, ``undecided``, ``valid`` or The possible status values are ``backlog``, ``undecided``, ``valid`` or
``invalid``. ``invalid``.
@ -83,8 +83,8 @@ GET /statuses/2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e
``valid`` or ``undecided``, a ``303 See Other`` status code is returned, as ``valid`` or ``undecided``, a ``303 See Other`` status code is returned, as
well as a URL to the resource in the location header. well as a URL to the resource in the location header.
:param tx_id: transaction ID :param txid: transaction ID
:type tx_id: hex string :type txid: hex string
**Example request**: **Example request**:
@ -101,18 +101,18 @@ GET /statuses/2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e
:statuscode 404: A transaction with that ID was not found. :statuscode 404: A transaction with that ID was not found.
GET /transactions/{tx_id} GET /transactions/{txid}
------------------------- -------------------------
.. http:get:: /transactions/{tx_id} .. http:get:: /transactions/{txid}
Get the transaction with the ID ``tx_id``. Get the transaction with the ID ``txid``.
This endpoint returns only a transaction from a ``VALID`` or ``UNDECIDED`` This endpoint returns only a transaction from a ``VALID`` or ``UNDECIDED``
block on ``bigchain``, if exists. block on ``bigchain``, if exists.
:param tx_id: transaction ID :param txid: transaction ID
:type tx_id: hex string :type txid: hex string
**Example request**: **Example request**:
@ -128,10 +128,10 @@ GET /transactions/{tx_id}
:statuscode 404: A transaction with that ID was not found. :statuscode 404: A transaction with that ID was not found.
GET /transactions/{tx_id}/conditions/{cid} GET /transactions/{txid}/conditions/{cid}
------------------------- -------------------------
.. http:get:: /transactions/{tx_id}/conditions/{cid} .. http:get:: /transactions/{txid}/conditions/{cid}
Returns the condition with index ``cid`` from a transaction with ID Returns the condition with index ``cid`` from a transaction with ID
``txid``. ``txid``.
@ -140,8 +140,8 @@ GET /transactions/{tx_id}/conditions/{cid}
requested at the index ``cid`` is not found, this endpoint will return a requested at the index ``cid`` is not found, this endpoint will return a
``400 Bad Request``. ``400 Bad Request``.
:param tx_id: transaction ID :param txid: transaction ID
:type tx_id: hex string :type txid: hex string
:param cid: A condition's index in the transaction :param cid: A condition's index in the transaction
:type cid: integer :type cid: integer
@ -173,8 +173,8 @@ GET /transactions/{tx_id}/conditions/{cid}
} }
} }
:statuscode 200: A condition with ``cid`` was found in a transaction with ID ``tx_id``. :statuscode 200: A condition with ``cid`` was found in a transaction with ID ``txid``.
:statuscode 400: Either a transaction with ``tx_id`` or a condition with ``cid`` wasn't found. :statuscode 400: Either a transaction with ``txid`` or a condition with ``cid`` wasn't found.
GET /unspents/ GET /unspents/