#7: Added output data description.

edeposit · Nov 26, 2015 · 0a3a5ed · 0a3a5ed
1 parent 26da380
commit 0a3a5ed
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/src/edeposit/amqp/rest/html_templates/index.html b/src/edeposit/amqp/rest/html_templates/index.html
@@ -192,11 +192,45 @@
 /track
 ++++++
 
+Volání této části API vrátí stavy všech přes REST API ohlášených, ne-expirovaných dokumentů. Expirace probíhá řádově po měsících.
+
+Návratová hodnota
+^^^^^^^^^^^^^^^^^
+
+Typ slovník (dictionary) se strukturou ``{"rest_id": detaily}``, kde `detaily` je další slovník o následující struktuře:
+
++-------------+--------------------------------------------------------------------------+
+| Název klíče |                                  Význam                                  |
++=============+==========================================================================+
+| pub_url     | URL knihy v edepositu.                                                   |
++-------------+--------------------------------------------------------------------------+
+| book_name   | Název knihy v edepositu.                                                 |
++-------------+--------------------------------------------------------------------------+
+| messages    | Pole slovníků se strukturou ``{"message": "text", "timestamp": float}``. |
++-------------+--------------------------------------------------------------------------+
+
+Příklad
+^^^^^^^
+
+
 
 /track/<rest_id>
 ++++++++++++++++
 
+Návratová hodnota
+^^^^^^^^^^^^^^^^^
 
+Slovník s následující strukturou:
+
++-------------+--------------------------------------------------------------------------+
+| Název klíče |                                  Význam                                  |
++=============+==========================================================================+
+| pub_url     | URL knihy v edepositu.                                                   |
++-------------+--------------------------------------------------------------------------+
+| book_name   | Název knihy v edepositu.                                                 |
++-------------+--------------------------------------------------------------------------+
+| messages    | Pole slovníků se strukturou ``{"message": "text", "timestamp": float}``. |
++-------------+--------------------------------------------------------------------------+
 
 </rst>