summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2017-03-31 00:38:42 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2017-03-31 00:38:42 +0200
commit86aff5a8f24ec884bbc94509b456d87c52a7ada0 (patch)
treefad3707098f36f4c5f514a05d97979cbca79bbf0 /api
parent5a3b200c7b4054638eb9231bb78ff825cb880928 (diff)
downloaddocs-86aff5a8f24ec884bbc94509b456d87c52a7ada0.tar.gz
docs-86aff5a8f24ec884bbc94509b456d87c52a7ada0.tar.bz2
docs-86aff5a8f24ec884bbc94509b456d87c52a7ada0.zip
finishing bank's /history
Diffstat (limited to 'api')
-rw-r--r--api/api-bank.rst22
1 files changed, 21 insertions, 1 deletions
diff --git a/api/api-bank.rst b/api/api-bank.rst
index bfc4f44c..231be383 100644
--- a/api/api-bank.rst
+++ b/api/api-bank.rst
@@ -100,12 +100,32 @@ the number of results.
.. http:post:: /history
-**Request**
+**Request:** The body of this request must have the format of a `HistoryRequest`_.
TBD
**Response**
TBD
+.. _HistoryRequest:
+.. code-block:: tsref
+
+ interface HistoryRequest {
+
+ // The username of the user calling this API.
+ username: string;
+
+ // Password of the user calling this API.
+ password: string;
+
+ // Row number identifier in the bank's database
+ // such that only rows with GREATER (meaning younger
+ // records) row number will be returned.
+ start: number;
+
+ // How many rows we want returned, at most.
+ delta: number;
+ }
+
--------
Util API
--------