diff --git a/docs/server/generate_http_server_api_documentation.py b/docs/server/generate_http_server_api_documentation.py index 65ce61c0..ed76ed15 100644 --- a/docs/server/generate_http_server_api_documentation.py +++ b/docs/server/generate_http_server_api_documentation.py @@ -70,16 +70,16 @@ Content-Type: application/json TPLS['post-tx-response'] = """\ HTTP/1.1 202 Accepted Content-Type: application/json -Location: ../statuses/%(txid)s +Location: ../statuses?tx_id=%(txid)s { - "status": "/statuses/%(txid)s" + "status": "/statuses?tx_id=%(txid)s" } """ TPLS['get-statuses-tx-request'] = """\ -GET /statuses/%(txid)s HTTP/1.1 +GET /statuses?tx_id=%(txid)s HTTP/1.1 Host: example.com """ @@ -90,10 +90,7 @@ HTTP/1.1 200 OK Content-Type: application/json { - "status": "invalid", - "_links" : { - "block": "/blocks/%(blockid)s" - } + "status": "invalid" } """ @@ -104,11 +101,7 @@ Content-Type: application/json Location: ../transactions/%(txid)s { - "status": "valid", - "_links" : { - "tx" : "/transactions/%(txid)s", - "block": "/blocks/%(blockid)s" - } + "status": "valid" } """ diff --git a/docs/server/source/drivers-clients/http-client-server-api.rst b/docs/server/source/drivers-clients/http-client-server-api.rst index 24e354c7..5cbb7bed 100644 --- a/docs/server/source/drivers-clients/http-client-server-api.rst +++ b/docs/server/source/drivers-clients/http-client-server-api.rst @@ -257,12 +257,13 @@ Transactions Statuses -------------------------------- -.. http:get:: /statuses/{tx_id|block_id} +.. http:get:: /statuses?tx_id={tx_id}|block_id={block_id} Get the status of an asynchronously written resource by their id. Supports the retrieval of a status for a transaction using ``tx_id`` or the - retrieval of a status for a block using ``block_id``. + retrieval of a status for a block using ``block_id``. Only use exactly one of both + queries, as they are required but mutually exclusive. The possible status values are ``backlog``, ``undecided``, ``valid`` or ``invalid``. @@ -312,7 +313,7 @@ Blocks that was labeled ``UNDECIDED`` or ``INVALID`` is requested by ``block_id``, this endpoint will return a ``404 Not Found`` status code to warn the user. To check a block's status independently, use the - `Statuses endpoint <#get--statuses-tx_id|block_id>`_. The ``INVALID`` status + `Statuses endpoint <#get--statuses?tx_id=tx_id|block_id=block_id>`_. The ``INVALID`` status can be handy to figure out why the block was rejected. :param block_id: block ID