diff docs/api/api.rst @ 2244:ee45677c4edc beta

Api docs fixes - return proper type instead of type_ - members return now also a type user or users_group
author Marcin Kuzminski <marcin@python-works.com>
date Tue, 20 Mar 2012 23:26:02 +0200
parents c1f1f0661090
children 12ceeda33339
line wrap: on
line diff
--- a/docs/api/api.rst	Tue Mar 20 13:23:38 2012 +0200
+++ b/docs/api/api.rst	Tue Mar 20 23:26:02 2012 +0200
@@ -380,7 +380,8 @@
 get_repo
 --------
 
-Gets an existing repository by it's name or repository_id. This command can 
+Gets an existing repository by it's name or repository_id. Members will return
+either users_group or user associated to that repository. This command can 
 be executed only using api_key belonging to user with admin rights.
 
 
@@ -402,7 +403,9 @@
                 "type" :        "<type>",
                 "description" : "<description>",
                 "members" :     [
-                                  { "id" :         "<userid>",
+                                  { 
+                                    "type": "user",
+                                    "id" :         "<userid>",
                                     "username" :   "<username>",
                                     "firstname":   "<firstname>",
                                     "lastname" :   "<lastname>",
@@ -413,7 +416,8 @@
                                     "permission" : "repository.(read|write|admin)"
                                   },

-                                  {
+                                  { 
+                                    "type": "users_group",
                                     "id" :       "<usersgroupid>",
                                     "name" :     "<usersgroupname>",
                                     "active":    "<bool>",