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

Add docs about /transactions endpoint

Browse Source
This commit is contained in:
tim 2016-11-16 16:40:08 +01:00
parent f18f3cb8d2
commit eda8cdbba1
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -115,6 +115,46 @@ Transactions
:statuscode 200: A transaction with that ID was found.
:statuscode 404: A transaction with that ID was not found.
.. http:get:: /transactions
The current ``/transactions`` endpoint returns a ``404 Not Found`` HTTP
status code. Eventually, this functionality will get implemented.
We believe a PUSH rather than a PULL pattern is more appropriate, as the
items returned in the collection would change by the second.
There are however requests that might come of use, given the endpoint is
queried correctly. Some of them include retrieving a list of transactions
that include:
* `Unfulfilled conditions <#get--transactions?fields=id,conditions&fulfilled=false&owner_afters=owners_after>`_
* `A specific asset <#get--transactions?fields=id,asset,operation&operation=CREATE|TRANSFER&asset_id=asset_id>`_
* `Specific metadata <#get--transactions?fields=id,metadata&metadata_id=metadata_id>`_
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.
A generalization of those parameters can follows:
:query fields: A comma separated string to expand properties on the transaction object to be returned.
:type fields: string
:query fulfilled: A flag to indicate if transaction's with fulfilled conditions should be returned.
:type fulfilled: boolean
:query owners_after: Public keys able to validly spend an output of a transaction, assuming the user also has the corresponding private key.
:type owners_after: base58 encoded string
:query operation: One of the three supported operations of a transaction.
:type operation: string
:query asset_id: asset ID.
:type asset_id: uuidv4
:query metadata_id: metadata ID.
:type metadata_id: uuidv4
:statuscode 404: BigchainDB does not expose this endpoint.
.. http:get:: /transactions?fields=id,conditions&fulfilled=false&owner_afters={owners_after}
Get a list of transactions with unfulfilled conditions.