From 0a3a5edb1d31139c4e6808b453d723788c482606 Mon Sep 17 00:00:00 2001 From: Bystroushaak Date: Thu, 26 Nov 2015 18:13:22 +0100 Subject: [PATCH] #7: Added output data description. --- .../amqp/rest/html_templates/index.html | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/src/edeposit/amqp/rest/html_templates/index.html b/src/edeposit/amqp/rest/html_templates/index.html index e66789a..02e188c 100644 --- 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/ ++++++++++++++++ +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}``. | ++-------------+--------------------------------------------------------------------------+