diff options
author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-10-01 14:20:57 +0400 |
---|---|---|
committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-10-01 14:20:57 +0400 |
commit | ca1c35aa51f8350c09f7a0a42bbf0008941bf1b3 (patch) | |
tree | 0652e3a26d46e23289c102c3923326fff8968e20 /lib | |
parent | 8b1da505e0f46f720d5097c4850ee83f10cc8d51 (diff) | |
parent | f030ee846ed39c5e0a326e8ba117ec79f40e230d (diff) |
Merge branch 'fork-via-API' into 'master'
API: Add support for forking a project via the API
This adds an API call to create a fork of a project.
Such API "fork button" has been requested by feature requests summing up with 37 votes.
The GitLab user has flagged one of them as accepting merge/pull requests for this feature.
Motivation:
The ability to create a fork is missing in the API.
(The API currently only supports adding and removing the "forked" relationship between two existing projects)
This feature (create fork thru the API) feature has been requested via two feature requests:
15 votes, 13 comments: to be able to fork a project through the API
http://feedback.gitlab.com/forums/176466-general/suggestions/4125380-to-be-able-to-fork-a-project-through-the-api (it was marked as completed in error by referring to the much more special change which allows to add&delete fork information)
22 votes, 3 comments: add a "fork project" API call that acts like the "fork button"
http://feedback.gitlab.com/forums/176466-general/suggestions/5820264-add-a-fork-project-api-call-that-acts-like-the
The implementation is described in the text of the commit message (click on the "..." field to open it).
A comprehensive test suite is added as well: It covers all 5 success / failure modes:
1. Success case
2. Failure if authenticated user has no access the the project to be forked
3. Failure if the forked project already exists in the authenticated user's namespace
4. Failure if the forked project does not exist
5. Failure if not authenticated
Documentation for the new API call is added to the project help page: doc/api/projects.md
I have 2 additional merge requests in progress, one is based on this feature and extend it, the other is related to querying forks.
The merge request that would be directly related is based on a request written comment of one of the feature requests (that was independently also requested in a but entry):
The ability to fork a project (thru the API) to a given namespace, eg. a group, in one case, for trainings.
As this request does not change code, but only adds a new request API for creating forks, it does not have
the capability to break existing code, and as the test spec demonstrates, it works.
It allocates the API request POST /projects/fork/:id, the only other API path I'd have thought of would have been POST /projects/:id/fork but that path is already taken by the API for creating a new fork relationship between projects, so POST /projects/fork/:id is the remaining possibility that I could see.
See merge request !191
Diffstat (limited to 'lib')
-rw-r--r-- | lib/api/projects.rb | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/api/projects.rb b/lib/api/projects.rb index f555819df1b..7f7d2f8e9a8 100644 --- a/lib/api/projects.rb +++ b/lib/api/projects.rb @@ -153,6 +153,23 @@ module API end end + # Fork new project for the current user. + # + # Parameters: + # id (required) - The ID of a project + # Example Request + # POST /projects/fork/:id + post 'fork/:id' do + @forked_project = + ::Projects::ForkService.new(user_project, + current_user).execute + if @forked_project.errors.any? + conflict!(@forked_project.errors.messages) + else + present @forked_project, with: Entities::Project + end + end + # Remove project # # Parameters: |