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

owner_after --> owners_after

Browse Source 
Querystring keywords should be in line with data model.
This commit is contained in:
tim 2016-11-16 13:48:14 +01:00
parent e243a1be9b
commit 85d9553a1e
1 changed files with 11 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -69,7 +69,7 @@ POST /transactions/
:statuscode 400: The transaction was invalid and not created. :statuscode 400: The transaction was invalid and not created.
GET /statuses/2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e GET /statuses
-------------------------------- --------------------------------
.. http:get:: /statuses/{txid} .. http:get:: /statuses/{txid}
@ -105,35 +105,32 @@ GET /statuses/2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e
GET /transactions GET /transactions
------------------------- -------------------------
.. http:get:: /transactions?fields=id,conditions&fulfilled=false&owner_after={owner_after} .. http:get:: /transactions?fields=id,conditions&fulfilled=false&owner_afters={owners_after}
Get a list of transactions with unfulfilled conditions (conditions that have Get a list of transactions with unfulfilled conditions (conditions that have
not been used yet in a persisted transaction. not been used yet in a persisted transaction.
If the querystring ``fulfilled`` is set to ``false`` and all conditions for If the querystring ``fulfilled`` is set to ``false`` and all conditions for
``owner_after`` happen to be fulfilled already, this endpoint will return ``owners_after`` happen to be fulfilled already, this endpoint will return
an empty list. an empty list.
This endpoint will return a ``HTTP 400 Bad Request`` if the querystring
.. note:: ``owners_after`` happens to not be defined in the request.
This endpoint will return a ``HTTP 400 Bad Request`` if the querystring
``owner_after`` happens to not be defined in the request.
:param fields: The fields to be included in a transaction. :param fields: The fields to be included in a transaction.
:type fields: string :type fields: string
:param fulfilled: A flag to indicate if transaction's with fulfilled conditions should be returned. :param fulfilled: A flag to indicate if transaction's with fulfilled conditions should be returned.
:type fields: boolean :type fulfilled: boolean
:param owner_after: A public key, able to validly spend an output of a transaction, assuming the user also has the corresponding private key. :param owners_after: Public keys able to validly spend an output of a transaction, assuming the user also has the corresponding private key.
:type owner_after: base58 encoded string :type owners_after: base58 encoded string
**Example request**: **Example request**:
.. sourcecode:: http .. sourcecode:: http
GET /transactions?fields=id,conditions&fulfilled=false&owner_after=1AAAbbb...ccc HTTP/1.1 GET /transactions?fields=id,conditions&fulfilled=false&owners_after=1AAAbbb...ccc HTTP/1.1
Host: example.com Host: example.com
**Example response**: **Example response**:
@ -165,11 +162,10 @@ GET /transactions
} }
], ],
"id": "2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e", "id": "2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e",
}, ...] }]
:statuscode 200: A list of transaction's containing unfulfilled conditions was found and returned. :statuscode 200: A list of transaction's containing unfulfilled conditions was found and returned.
:statuscode 400: The request wasn't understood by the server, e.g. the ``owner_after`` querystring was not included in the request. :statuscode 400: The request wasn't understood by the server, e.g. the ``owners_after`` querystring was not included in the request.
GET /transactions/{txid} GET /transactions/{txid}
------------------------- -------------------------