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

Remove controversial endpoints for now

Browse Source
This commit is contained in:
tim 2017-01-25 11:30:40 +01:00
parent 7a71e386f3
commit 5b7dd672b8
2 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/server/generate_http_server_api_documentation.py
View File

@ -67,7 +67,7 @@ Content-Type: application/json
TPLS['post-tx-response'] = """\
HTTP/1.1 200 OK
HTTP/1.1 202 Accepted
Content-Type: application/json
%(tx)s

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

@ -45,8 +45,8 @@ Transactions
Get the transaction with the ID ``tx_id``.
This endpoint returns only a transaction from the ``BACKLOG`` or a ``VALID`` or ``UNDECIDED``
block on ``bigchain``, if exists.
This endpoint returns a transaction only if a ``VALID`` block on
``bigchain`` exists.
:param tx_id: transaction ID
:type tx_id: hex string
@ -144,7 +144,7 @@ Transactions
:resheader Content-Type: ``application/json``
:statuscode 200: The pushed transaction was accepted in the ``BACKLOG``, but the processing has not been completed.
:statuscode 202: The pushed transaction was accepted in the ``BACKLOG``, but the processing has not been completed.
:statuscode 400: The transaction was malformed and not accepted in the ``BACKLOG``.
@ -198,10 +198,6 @@ Statuses
Get the status of an asynchronously written transaction or block by their id.
The possible status values are ``undecided``, ``valid`` or ``invalid`` for
both blocks and transactions. An additional state ``backlog`` is provided
for transactions.
A link to the resource is also provided in the returned payload under
``_links``.
@ -220,6 +216,10 @@ Statuses
Get the status of a transaction.
The possible status values are ``undecided``, ``valid`` or ``backlog``.
If a transaction in neither of those states is found, a ``404 Not Found``
HTTP status code is returned. `We're currently looking into ways to unambigously let the user know about a transaction's status that was included in an invalid block. <https://github.com/bigchaindb/bigchaindb/issues/1039>`_
**Example request**:
.. literalinclude:: samples/get-statuses-tx-request.http
@ -227,11 +227,6 @@ Statuses
**Example response**:
.. literalinclude:: samples/get-statuses-tx-invalid-response.http
:language: http
**Example response**:
.. literalinclude:: samples/get-statuses-tx-valid-response.http
:language: http
@ -246,6 +241,8 @@ Statuses
Get the status of a block.
The possible status values are ``undecided``, ``valid`` or ``invalid``.
**Example request**:
.. literalinclude:: samples/get-statuses-block-request.http