aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarcin Kuzminski <marcin@python-works.com>2013-03-05 20:03:33 +0100
committerMarcin Kuzminski <marcin@python-works.com>2013-03-05 20:03:33 +0100
commit1cf846b6993208d036842942016b56c71db4f822 (patch)
tree0b31943511a1337549fb2917aa9af14d9a5a7739 /docs
parent4b7bbaa23618f55ae932fde9e48dca1359c85867 (diff)
calling lock function without lock attribute, will return lock state
--HG-- branch : beta
Diffstat (limited to 'docs')
-rw-r--r--docs/api/api.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/api/api.rst b/docs/api/api.rst
index ecabbfe8..d2a83a6e 100644
--- a/docs/api/api.rst
+++ b/docs/api/api.rst
@@ -178,7 +178,8 @@ lock
----
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.
+, then it is set to id of user whos calling this method. If locked param is skipped
+then function shows current lock state of given repo.
This command can be executed only using api_key belonging to user with admin
rights or regular user that have admin or write access to repository.
@@ -190,7 +191,7 @@ INPUT::
args : {
"repoid" : "<reponame or repo_id>"
"userid" : "<user_id or username = Optional(=apiuser)>",
- "locked" : "<bool true|false>"
+ "locked" : "<bool true|false = Optional(=None)>"
}
OUTPUT::