changeset 3213:f5dcee2b3153 beta

updated api docs
author Marcin Kuzminski <marcin@python-works.com>
date Thu, 24 Jan 2013 00:32:20 +0100
parents 6c28533d122c
children 54a596abfa65
files docs/api/api.rst
diffstat 1 files changed, 19 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/docs/api/api.rst	Wed Jan 23 23:51:57 2013 +0100
+++ b/docs/api/api.rst	Thu Jan 24 00:32:20 2013 +0100
@@ -236,6 +236,7 @@
     result: None if user does not exist or 
             {
                 "user_id" :     "<user_id>",
+                "api_key" :     "<api_key>",
                 "username" :    "<username>",
                 "firstname":    "<firstname>",
                 "lastname" :    "<lastname>",
@@ -616,7 +617,7 @@
                 "fork_of":           "<name_of_fork_parent>",
                 "members" :     [
                                   { 
-                                    "type": "user",
+                                    "type":        "user",
                                     "user_id" :    "<user_id>",
                                     "username" :   "<username>",
                                     "firstname":   "<firstname>",
@@ -631,7 +632,7 @@
                                   },

                                   { 
-                                    "type": "users_group",
+                                    "type":      "users_group",
                                     "id" :       "<usersgroupid>",
                                     "name" :     "<usersgroupname>",
                                     "active":    "<bool>",
@@ -639,6 +640,22 @@
                                   },

                                 ]
+                 "followers":   [
+                                  {
+                                    "user_id" :     "<user_id>",
+                                    "username" :    "<username>",
+                                    "firstname":    "<firstname>",
+                                    "lastname" :    "<lastname>",
+                                    "email" :       "<email>",
+                                    "emails":       "<list_of_all_additional_emails>",
+                                    "ip_addresses": "<list_of_ip_addresses_for_user>",
+                                    "active" :      "<bool>",
+                                    "admin" :       "<bool>",
+                                    "ldap_dn" :     "<ldap_dn>",
+                                    "last_login":   "<last_login>",                                    
+                                  },
+                                  …           
+                 ]
             }
     error:  null