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

document optional operation parameter in transaction

Browse Source
This commit is contained in:
Scott Sadler 2017-01-23 16:37:50 +01:00 committed by tim
parent d932184b88
commit 88b99d7bdc
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -74,7 +74,7 @@ Transactions
queried correctly. Some of them include retrieving a list of transactions
that include:
* `Transactions related to a specific asset <#get--transactions?operation=CREATE|TRANSFER&asset_id=asset_id>`_
* `Transactions related to a specific asset <#get--transactions?asset_id=asset_id&operation=CREATE|TRANSFER>`_
In this section, we've listed those particular requests, as they will likely
to be very handy when implementing your application on top of BigchainDB.
@ -85,11 +85,11 @@ Transactions
A generalization of those parameters follows:
:query string operation: One of the two supported operations of a transaction: ``CREATE``, ``TRANSFER``.
:query string asset_id: The ID of the asset.
.. http:get:: /api/v1/transactions?operation={CREATE|TRANSFER}&asset_id={asset_id}
:query string operation: (Optional) One of the two supported operations of a transaction: ``CREATE``, ``TRANSFER``.
.. http:get:: /api/v1/transactions?asset_id={asset_id}&operation={CREATE|TRANSFER}
Get a list of transactions that use an asset with the ID ``asset_id``.
Every ``TRANSFER`` transaction that originates from a ``CREATE`` transaction
@ -98,7 +98,7 @@ Transactions
This endpoint returns transactions only if they are decided ``VALID`` by the server.
:query string operation: One of the two supported operations of a transaction: ``CREATE``, ``TRANSFER``.
:query string operation: (Optional) One of the two supported operations of a transaction: ``CREATE``, ``TRANSFER``.
:query string asset_id: asset ID.