summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2017-05-03 21:29:05 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2017-05-03 21:29:05 +0200
commit9c2673a675599c1d5b84f26b4ce2dee13aa5640a (patch)
tree6a8aa501e87077b5ba328b881f224606b90bf982 /api
parent99481f0a18c6262ff2556ac41e5397c491cd665d (diff)
downloaddocs-9c2673a675599c1d5b84f26b4ce2dee13aa5640a.tar.gz
docs-9c2673a675599c1d5b84f26b4ce2dee13aa5640a.tar.bz2
docs-9c2673a675599c1d5b84f26b4ce2dee13aa5640a.zip
bank's /history used to be a mix of POSTed JSON *and*
URI's parameters (!). Making all POSTed JSON.
Diffstat (limited to 'api')
-rw-r--r--api/api-bank.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/api/api-bank.rst b/api/api-bank.rst
index c1b9febe..8bfffa03 100644
--- a/api/api-bank.rst
+++ b/api/api-bank.rst
@@ -115,16 +115,28 @@ the number of results.
.. http:post:: /history
- **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.
+ **Request** JSON of type `HistoryRequest`_.
**Response** JSON array of type `BankTransaction`_.
+.. _HistoryRequest:
+.. code-block:: tsref
+
+ interface HistoryRequest {
+
+ // Authentication credentials to get right of
+ // issuing this call.
+ auth: BasicAuth;
+
+ // 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.
+ direction: string;
+
+ }
.. _BankTransaction:
.. code-block:: tsref