diff options
| author | Angus MacArthur <amacarthur@blackberry.com> | 2013-03-06 08:48:40 +0400 |
|---|---|---|
| committer | Angus MacArthur <amacarthur@blackberry.com> | 2013-03-06 08:48:40 +0400 |
| commit | 47abdc10ca7daceac8206a65166b42409a76b459 (patch) | |
| tree | 528ae1f3e7f4378d8df56de909cc6a2902e55986 /doc | |
| parent | 61ffcab60fef2efcd54b8496aa09de79ee999a2c (diff) | |
Updated documentation for added Admin APIs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/groups.md | 11 | ||||
| -rw-r--r-- | doc/api/projects.md | 22 | ||||
| -rw-r--r-- | doc/api/users.md | 17 |
3 files changed, 50 insertions, 0 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index 00a7387c76f..4cde66b1726 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -43,3 +43,14 @@ Parameters: Will return created group with status `201 Created` on success, or `404 Not found` on fail. +## Transfer project to group + +Transfer a project to the Group namespace. Available only for admin + +``` +POST /groups/:id/projects/:project_id +``` + +Parameters: ++ `id` (required) - The ID of a group ++ `project_id (required) - The ID of a project diff --git a/doc/api/projects.md b/doc/api/projects.md index ed9690f09a2..32b7077ab09 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -113,6 +113,28 @@ Parameters: Will return created project with status `201 Created` on success, or `404 Not found` on fail. +## Create project for user + +Create new project owned by user. Available only for admin + +``` +POST /projects/user/:user_id +``` + +Parameters: + ++ `user_id` (required) - user_id of owner ++ `name` (required) - new project name ++ `description` (optional) - short project description ++ `default_branch` (optional) - 'master' by default ++ `issues_enabled` (optional) - enabled by default ++ `wall_enabled` (optional) - enabled by default ++ `merge_requests_enabled` (optional) - enabled by default ++ `wiki_enabled` (optional) - enabled by default + +Will return created project with status `201 Created` on success, or `404 Not +found` on fail. + ## List project team members Get a list of project team members. diff --git a/doc/api/users.md b/doc/api/users.md index b94d7c0f789..b75e84c6b96 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -220,6 +220,23 @@ Parameters: Will return created key with status `201 Created` on success, or `404 Not found` on fail. +## Add SSH key for user + +Create new key owned by specified user. Available only for admin + +``` +POST /users/:id/keys +``` + +Parameters: + ++ `id` (required) - id of specified user ++ `title` (required) - new SSH Key's title ++ `key` (required) - new SSH key + +Will return created key with status `201 Created` on success, or `404 Not +found` on fail. + ## Delete SSH key Delete key owned by currently authenticated user |