Commit 47abdc10ca7daceac8206a65166b42409a76b459
1 parent
61ffcab6
Exists in
master
and in
4 other branches
Updated documentation for added Admin APIs
Showing
3 changed files
with
50 additions
and
0 deletions
Show diff stats
doc/api/groups.md
| ... | ... | @@ -43,3 +43,14 @@ Parameters: |
| 43 | 43 | |
| 44 | 44 | Will return created group with status `201 Created` on success, or `404 Not found` on fail. |
| 45 | 45 | |
| 46 | +## Transfer project to group | |
| 47 | + | |
| 48 | +Transfer a project to the Group namespace. Available only for admin | |
| 49 | + | |
| 50 | +``` | |
| 51 | +POST /groups/:id/projects/:project_id | |
| 52 | +``` | |
| 53 | + | |
| 54 | +Parameters: | |
| 55 | ++ `id` (required) - The ID of a group | |
| 56 | ++ `project_id (required) - The ID of a project | ... | ... |
doc/api/projects.md
| ... | ... | @@ -113,6 +113,28 @@ Parameters: |
| 113 | 113 | Will return created project with status `201 Created` on success, or `404 Not |
| 114 | 114 | found` on fail. |
| 115 | 115 | |
| 116 | +## Create project for user | |
| 117 | + | |
| 118 | +Create new project owned by user. Available only for admin | |
| 119 | + | |
| 120 | +``` | |
| 121 | +POST /projects/user/:user_id | |
| 122 | +``` | |
| 123 | + | |
| 124 | +Parameters: | |
| 125 | + | |
| 126 | ++ `user_id` (required) - user_id of owner | |
| 127 | ++ `name` (required) - new project name | |
| 128 | ++ `description` (optional) - short project description | |
| 129 | ++ `default_branch` (optional) - 'master' by default | |
| 130 | ++ `issues_enabled` (optional) - enabled by default | |
| 131 | ++ `wall_enabled` (optional) - enabled by default | |
| 132 | ++ `merge_requests_enabled` (optional) - enabled by default | |
| 133 | ++ `wiki_enabled` (optional) - enabled by default | |
| 134 | + | |
| 135 | +Will return created project with status `201 Created` on success, or `404 Not | |
| 136 | +found` on fail. | |
| 137 | + | |
| 116 | 138 | ## List project team members |
| 117 | 139 | |
| 118 | 140 | Get a list of project team members. | ... | ... |
doc/api/users.md
| ... | ... | @@ -220,6 +220,23 @@ Parameters: |
| 220 | 220 | Will return created key with status `201 Created` on success, or `404 Not |
| 221 | 221 | found` on fail. |
| 222 | 222 | |
| 223 | +## Add SSH key for user | |
| 224 | + | |
| 225 | +Create new key owned by specified user. Available only for admin | |
| 226 | + | |
| 227 | +``` | |
| 228 | +POST /users/:id/keys | |
| 229 | +``` | |
| 230 | + | |
| 231 | +Parameters: | |
| 232 | + | |
| 233 | ++ `id` (required) - id of specified user | |
| 234 | ++ `title` (required) - new SSH Key's title | |
| 235 | ++ `key` (required) - new SSH key | |
| 236 | + | |
| 237 | +Will return created key with status `201 Created` on success, or `404 Not | |
| 238 | +found` on fail. | |
| 239 | + | |
| 223 | 240 | ## Delete SSH key |
| 224 | 241 | |
| 225 | 242 | Delete key owned by currently authenticated user | ... | ... |