diff docs/api/api.rst @ 3161:3563c47e52fd beta

Implemented API calls for non-admin users for locking/unlocking repositories
author Marcin Kuzminski <marcin@python-works.com>
date Sun, 13 Jan 2013 22:55:56 +0100
parents 71ce052f8b6b
children a0a8f38e8fb8
line wrap: on
line diff
--- a/docs/api/api.rst	Sun Jan 13 20:03:15 2013 +0100
+++ b/docs/api/api.rst	Sun Jan 13 22:55:56 2013 +0100
@@ -155,9 +155,10 @@
 lock
 ----
 
-Set locking state on given repository by given user.
+Set locking state on given repository by given user. If userid param is skipped
+, then it is set to id of user whos calling this method.
 This command can be executed only using api_key belonging to user with admin 
-rights.
+rights or regular user that have admin or write access to repository.
 
 INPUT::
 
@@ -166,7 +167,7 @@
     method :  "lock"
     args :    {
                 "repoid" : "<reponame or repo_id>"
-                "userid" : "<user_id or username>",
+                "userid" : "<user_id or username = Optional(=apiuser)>",
                 "locked" : "<bool true|false>"
               }