Mercurial > kallithea
changeset 3122:4ef6a7ed5e3e beta
#699: fix missing fork docs for API
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Wed, 19 Dec 2012 23:27:10 +0100 |
| parents | 3274ba9f1489 |
| children | 324ed41c11b1 |
| files | docs/api/api.rst |
| diffstat | 1 files changed, 36 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/api/api.rst Wed Dec 19 23:12:33 2012 +0100 +++ b/docs/api/api.rst Wed Dec 19 23:27:10 2012 +0100 @@ -711,7 +711,7 @@ "created_on" : "<datetimecreated>", "description" : "<description>", "landing_rev": "<landing_rev>", - "owner": "<repo_owner>", + "owner": "<username or user_id>", "fork_of": "<name_of_fork_parent>", "enable_downloads": "<bool>", "enable_locking": "<bool>", @@ -721,6 +721,41 @@ error: null +fork_repo +--------- + +Creates a fork of given repo. This command can be executed only using api_key +belonging to user with admin rights. In case of using celery this will +immidiatelly return success message, while fork is going to be created +asynchronous + + +INPUT:: + + id : <id_for_response> + api_key : "<api_key>" + method : "fork_repo" + args: { + "repoid" : "<reponame or repo_id>", + "fork_name": "<forkname>", + "owner": "<username or user_id>", + "description": "<description>", + "copy_permissions": "<bool>", + "private": "<bool>", + "landing_rev": "<landing_rev>" + + } + +OUTPUT:: + + id : <id_given_in_input> + result: { + "msg": "Created fork of `<reponame>` as `<forkname>`", + "success": true + } + error: null + + delete_repo -----------