diff options
| author | Marcin Kuzminski <marcin@python-works.com> | 2012-12-19 23:27:10 +0100 |
|---|---|---|
| committer | Marcin Kuzminski <marcin@python-works.com> | 2012-12-19 23:27:10 +0100 |
| commit | 78bc420c31a921e51319f40e1ad364adf8d91942 (patch) | |
| tree | fe6b5d2a7d851e1ea8bc4a85f4aaab8256ce5905 | |
| parent | 5b286072b13a800b59d44633212a054b67f5064f (diff) | |
#699: fix missing fork docs for API
--HG--
branch : beta
| -rw-r--r-- | docs/api/api.rst | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/docs/api/api.rst b/docs/api/api.rst index 335dd942..e4a27137 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -711,7 +711,7 @@ OUTPUT:: "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 @@ OUTPUT:: 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 ----------- |