summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorBernhard Kaindl <bkl@use.startmail.com>2014-10-01 10:20:40 +0200
committerBernhard Kaindl <bkl@use.startmail.com>2014-10-01 10:27:48 +0200
commitf030ee846ed39c5e0a326e8ba117ec79f40e230d (patch)
tree8e95dbeb3720fc5805d9f70b765cedfad199f2d2 /doc/api
parent88d3e97e502f0be4f01fed100a06e04b2e0f2017 (diff)
downloadgitlab-ce-f030ee846ed39c5e0a326e8ba117ec79f40e230d.tar.gz
API: Initial support for forking a project via the API
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.
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/projects.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 9f6f6741093..8385e11b805 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -281,6 +281,18 @@ Parameters:
- `visibility_level` (optional)
- `import_url` (optional)
+### Fork project
+
+Forks a project into the user namespace of the authenticated user.
+
+```
+POST /projects/fork/:id
+```
+
+Parameters:
+
+- `id` (required) - The ID of the project to be forked
+
### Remove project
Removes a project including all associated resources (issues, merge requests etc.)