kallithea Changeset - ee45677c4edc

Changeset - ee45677c4edc

Parent rev.

Child rev.

[Not reviewed]

beta

0 3 0

Marcin Kuzminski - 14 years ago 2012-03-20 22:26:02
marcin@python-works.com

Api docs fixes
- return proper type instead of type_
- members return now also a type user or users_group

3 files changed with 11 insertions and 7 deletions:

README.rst

docs/api/api.rst

rhodecode/controllers/api/api.py

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

@@ @@ -97,13 +97,13 @@ RhodeCode Features @@
   (no external search servers required all in one application)
 - Setup project descriptions and info inside built in db for easy, non
   file-system operations
 - Intelligent cache with invalidation after push or project change, provides
   high performance and always up to date data.
 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
-- Async tasks for speed and performance using celery_ (works without them too)
+- Optional async tasks for speed and performance using celery_
 - Backup scripts can do backup of whole app and send it over scp to desired
   location
 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
 Incoming / Plans

docs/api/api.rst

➞

Show inline comments

@@ @@ -377,13 +377,14 @@ OUTPUT:: @@
     error:  null
 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.
 INPUT::
     id : <id_for_response>
@@ @@ -399,24 +400,27 @@ OUTPUT:: @@
+            {
                 "id" :          "<id>",
                 "repo_name" :   "<reponame>"
                 "type" :        "<type>",
                 "description" : "<description>",
                 "members" :     [
                                   { "id" :         "<userid>",
+                                  {
                                     "type": "user",
                                     "id" :         "<userid>",
                                     "username" :   "<username>",
                                     "firstname":   "<firstname>",
                                     "lastname" :   "<lastname>",
                                     "email" :      "<email>",
                                     "active" :     "<bool>",
                                     "admin" :      "<bool>",
                                     "ldap" :       "<ldap_dn>",
                                     "permission" : "repository.(read|write|admin)"
                                   },
                                   …
+                                  {
+                                  {
                                     "type": "users_group",
                                     "id" :       "<usersgroupid>",
                                     "name" :     "<usersgroupname>",
                                     "active":    "<bool>",
                                     "permission" : "repository.(read|write|admin)"
                                   },
                                   …

rhodecode/controllers/api/api.py

➞

Show inline comments

@@ @@ -280,13 +280,13 @@ class ApiController(JSONRPCController): @@
             log.error(traceback.format_exc())
             raise JSONRPCError('failed to create group %s' % group_name)
     @HasPermissionAllDecorator('hg.admin')
     def add_user_to_users_group(self, apiuser, group_name, username):
         """"
         Add a user to a group
+        Add a user to a users group
         :param apiuser:
         :param group_name:
         :param username:
         """
@@ @@ -358,13 +358,13 @@ class ApiController(JSONRPCController): @@
         members = []
         for user in repo.repo_to_perm:
             perm = user.permission.permission_name
             user = user.user
             members.append(
                 dict(
-                    type_="user",
+                    type="user",
                     id=user.user_id,
                     username=user.username,
                     firstname=user.name,
                     lastname=user.lastname,
                     email=user.email,
                     active=user.active,
@@ @@ -375,13 +375,13 @@ class ApiController(JSONRPCController): @@
+            )
         for users_group in repo.users_group_to_perm:
             perm = users_group.permission.permission_name
             users_group = users_group.users_group
             members.append(
                 dict(
-                    type_="users_group",
+                    type="users_group",
                     id=users_group.users_group_id,
                     name=users_group.users_group_name,
                     active=users_group.users_group_active,
                     permission=perm
+                )
+            )

0 comments (0 inline, 0 general)