##// END OF EJS Templates
#699: fix missing fork docs for API
marcink -
r3122:4ef6a7ed beta
parent child Browse files
Show More
@@ -711,7 +711,7 b' OUTPUT::'
711 "created_on" : "<datetimecreated>",
711 "created_on" : "<datetimecreated>",
712 "description" : "<description>",
712 "description" : "<description>",
713 "landing_rev": "<landing_rev>",
713 "landing_rev": "<landing_rev>",
714 "owner": "<repo_owner>",
714 "owner": "<username or user_id>",
715 "fork_of": "<name_of_fork_parent>",
715 "fork_of": "<name_of_fork_parent>",
716 "enable_downloads": "<bool>",
716 "enable_downloads": "<bool>",
717 "enable_locking": "<bool>",
717 "enable_locking": "<bool>",
@@ -721,6 +721,41 b' OUTPUT::'
721 error: null
721 error: null
722
722
723
723
724 fork_repo
725 ---------
726
727 Creates a fork of given repo. This command can be executed only using api_key
728 belonging to user with admin rights. In case of using celery this will
729 immidiatelly return success message, while fork is going to be created
730 asynchronous
731
732
733 INPUT::
734
735 id : <id_for_response>
736 api_key : "<api_key>"
737 method : "fork_repo"
738 args: {
739 "repoid" : "<reponame or repo_id>",
740 "fork_name": "<forkname>",
741 "owner": "<username or user_id>",
742 "description": "<description>",
743 "copy_permissions": "<bool>",
744 "private": "<bool>",
745 "landing_rev": "<landing_rev>"
746
747 }
748
749 OUTPUT::
750
751 id : <id_given_in_input>
752 result: {
753 "msg": "Created fork of `<reponame>` as `<forkname>`",
754 "success": true
755 }
756 error: null
757
758
724 delete_repo
759 delete_repo
725 -----------
760 -----------
726
761
General Comments 0
You need to be logged in to leave comments. Login now