From c266bd489f19630f68c0c69fa7633c9b6a2a3b1f Mon Sep 17 00:00:00 2001
From: Martijn Voncken <mvoncken@gmail.com>
Date: Tue, 15 Jul 2008 19:06:21 +0000
Subject: [PATCH] update json docs

---
 deluge/ui/webui/json_api.py                   | 26 ++++++++++++++-----
 .../ui/webui/templates/ajax_demo/index.html   |  7 ++++-
 2 files changed, 26 insertions(+), 7 deletions(-)

diff --git a/deluge/ui/webui/json_api.py b/deluge/ui/webui/json_api.py
index 6f5e35e9a..e6d0e0af3 100644
--- a/deluge/ui/webui/json_api.py
+++ b/deluge/ui/webui/json_api.py
@@ -60,7 +60,7 @@ def json_response(result, id):
             "id":id
     })
 
-def json_error(message , id , msg_number=123):
+def json_error(message , id=-1, msg_number=123):
     log.error("JSON-error:%s" % message)
     print json.write({
         "version":"1.1",
@@ -81,10 +81,11 @@ class json_rpc:
     """
     #extra exposed methods
     json_exposed = ["update_ui","get_stats","system_listMethods"]
+    cache = {}
 
 
     def GET(self):
-        print '{"error":"only POST is supported"}'
+        return json_error("only POST is supported")
 
 
     def POST(self , name=None):
@@ -139,7 +140,20 @@ class json_rpc:
         return sclient.list_methods() + self.json_exposed
 
     def get_stats(self):
-        "returns global stats dict"
+        """
+        returns:
+        {{{
+        {
+        'download_rate':float(),
+        'upload_rate':float(),
+        'max_download':float(),
+        'max_upload':float(),
+        'num_connections':int(),
+        'max_num_connections':int(),
+        'dht_nodes',int()
+        }
+        }}}
+        """
         stats = {}
 
         aclient.get_download_rate(dict_cb('download_rate',stats))
@@ -161,14 +175,14 @@ class json_rpc:
         """
         Composite call.
         Goal : limit the number of ajax calls
-        === input ===
+
+        input:
         {{{
             keys: see get_torrent_status
             filter_dict: see label_get_filtered_ids # only effective if the label plugin is enabled.
             cache_id: # todo
-        }
         }}}
-        === output ===
+        returns:
         {{{
         {
             "torrents": see get_torrent_status
diff --git a/deluge/ui/webui/templates/ajax_demo/index.html b/deluge/ui/webui/templates/ajax_demo/index.html
index b22c47285..6ffd51dec 100644
--- a/deluge/ui/webui/templates/ajax_demo/index.html
+++ b/deluge/ui/webui/templates/ajax_demo/index.html
@@ -90,11 +90,16 @@ function update_ui() {
 </script>
 
 
-<h1>sclient:</h1>
+
+<h1>ui.client</h1>
+<a href="http://dev.deluge-torrent.org/wiki/Development/UiClient#Remoteapi">docs</a> <br>
+
 <button onclick="get_session_state()">get_session_state()</button>
 
 <button onclick="list_torrents()">List torrents using get_session_state() + get_torrents_status()</button> <br>
 <h1>json extra:</h1>
+
+<a href="http://dev.deluge-torrent.org/wiki/Development/WebUi/Json">Docs</a><br>
 <button onclick="get_stats()">get_stats()</button>
 
 <button onclick="update_ui()">update_ui()  filter on "Seeding"</button>