[GNUnet-SVN] [taler-api] branch master updated: refining bank's /history spec

[gnunet]

This is an automated email from the git hooks/post-receive script.

marcello pushed a commit to branch master
in repository api.

The following commit(s) were added to refs/heads/master by this push:
     new 054e435  refining bank's /history spec
054e435 is described below

commit 054e4351f850625420ba10a3078bfc078a7cb0d9
Author: Marcello Stanisci <address@hidden>
AuthorDate: Wed May 3 15:41:54 2017 +0200

    refining bank's /history spec
---
 api/api-bank.rst | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/api/api-bank.rst b/api/api-bank.rst
index 1fec586..099dbc9 100644
--- a/api/api-bank.rst
+++ b/api/api-bank.rst
@@ -115,9 +115,14 @@ the number of results.
 
 .. http:post:: /history
 
-**Request:** The body of this request must have the format of a 
`HistoryRequest`_.
+  **Request**
+  :query direction: Optional parameter that lets the caller specify
+  only incoming, outgoing, or both types of records.  If not given,
+  then the API will return both types; if set to `credit` (`debit`),
+  only incoming (outgoing) records are returned.
 
-**Response** JSON array of type `BankTransaction`_.
+
+  **Response** JSON array of type `BankTransaction`_.
 
 
 
@@ -135,12 +140,13 @@ the number of results.
     // Amount transferred
     amount: Amount;
 
-    // "-" if the transfer was outcoming, "+" if it was
-    // incoming.
+    // "-" if the transfer was outgoing, "+" if it was
+    // incoming.  This field is only present if the argument
+    // `direction` was NOT given.
     sign: string;
 
-    // Bank account number of the other party
-    // involved in the transaction.
+    // Bank account number of the other party involved in the
+    // transaction.
     counterpart: number; 
   
   }

-- 
To stop receiving notification emails like this one, please contact
address@hidden