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
Having local changes is quite common and it is a stumbling block when
upgrading GitLab. Because schema.rb is generated from the actual DB
schema it is OK to clear the local changes.
This change adds POST /projects/fork/:id to the API for forking
a project into the namespace of the authenticated user, like the
"create fork" link in the GUI does. It also calls the same code.
Failure and permission checks (except for conflict) are already
implemented and handled in ForkService and the API, so the added
code is simple and does not alter anything.
Marin Jankovski
Dmitriy Zaporozhets
Dmitriy Zaporozhets
Sytse Sijbrandij
Marin Jankovski
Sytse Sijbrandij
Robert Schilling
Jacob Vosmaer
Job van der Voort
Jacob Vosmaer
Ciro Santilli
Bernhard Kaindl