Mercurial > public > src > rhodecode
diff docs/api/api.rst @ 2098:14dffcfebb02 beta
API get_user and get_repo methods can fetch by id or names
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Tue, 21 Feb 2012 02:51:28 +0200 |
| parents | b63adad7c4af |
| children | 82a88013a3fd 17c9393e9645 |
line wrap: on
line diff
--- a/docs/api/api.rst Tue Feb 21 02:35:43 2012 +0200 +++ b/docs/api/api.rst Tue Feb 21 02:51:28 2012 +0200 @@ -87,7 +87,7 @@ get_user -------- -Get's an user by username, Returns empty result if user is not found. +Get's an user by username or user_id, Returns empty result if user is not found. This command can be executed only using api_key belonging to user with admin rights. @@ -97,7 +97,7 @@ api_key : "<api_key>" method : "get_user" args : { - "username" : "<username>" + "userid" : "<username or user_id>" } OUTPUT:: @@ -370,8 +370,8 @@ get_repo -------- -Gets an existing repository. This command can be executed only using api_key -belonging to user with admin rights +Gets an existing repository by it's name or repository_id. This command can +be executed only using api_key belonging to user with admin rights. INPUT:: @@ -379,7 +379,7 @@ api_key : "<api_key>" method : "get_repo" args: { - "repo_name" : "<reponame>" + "repoid" : "<reponame or repo_id>" } OUTPUT::