From 328f2ed1933d760fd8f09efee0184e2d9583960a Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Wed, 24 Jan 2018 16:43:35 +0100 Subject: [PATCH] Some minor copy-editing --- docs/server/source/http-client-server-api.rst | 24 ++++++++++--------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/server/source/http-client-server-api.rst b/docs/server/source/http-client-server-api.rst index c088f926..2a17220d 100644 --- a/docs/server/source/http-client-server-api.rst +++ b/docs/server/source/http-client-server-api.rst @@ -129,13 +129,23 @@ Transactions Tendermint offers a `broadcast API `_ with three different modes to post transactions. By setting the mode, a new transaction can be pushed with a different mode than the default. The default mode is ``async``, which - will return immediately and not wait to see if the transaction is valid. The ``sync`` mode will return after the transactions is validated, while ``commit`` - returns after a transaction is committed to a block. + will return immediately and not wait to see if the transaction is valid. The ``sync`` mode will return after the transaction is validated, while ``commit`` + returns after the transaction is committed to a block. .. note:: This option is only available when using BigchainDB with Tendermint. + .. note:: + + The posted `transaction + `_ + should be structurally valid and not spending an already spent output. + The steps to build a valid transaction are beyond the scope of this page. + One would normally use a driver such as the `BigchainDB Python Driver + `_ + to build a valid transaction. + :query string mode: (Optional) One of the three supported modes to send a transaction: ``async``, ``sync``, ``commit``. **Example request**: @@ -165,16 +175,8 @@ Transactions .. http:post:: /api/v1/transactions - The endpoint without any parameters will push a new transaction. If BigchainDB is used with Tendermint, the default mode ``async`` is used. + This endpoint (without any parameters) will push a new transaction. If BigchainDB is used with Tendermint, the default mode ``async`` is used. - .. note:: - The posted `transaction - `_ - should be structurally valid and not spending an already spent output. - The steps to build a valid transaction are beyond the scope of this page. - One would normally use a driver such as the `BigchainDB Python Driver - `_ - to build a valid transaction. Transaction Outputs -------------------