Commit d7ec7c794aee1a2749fd3e832c9fac312d003c63
1 parent
55880751
Exists in
master
and in
4 other branches
Removed user teams api docs.
Showing
2 changed files
with
1 additions
and
210 deletions
Show diff stats
doc/api/README.md
doc/api/user_teams.md
| ... | ... | @@ -1,209 +0,0 @@ |
| 1 | -## User teams | |
| 2 | - | |
| 3 | -### List user teams | |
| 4 | - | |
| 5 | -Get a list of user teams viewable by the authenticated user. | |
| 6 | - | |
| 7 | -``` | |
| 8 | -GET /user_teams | |
| 9 | -``` | |
| 10 | - | |
| 11 | -```json | |
| 12 | -[ | |
| 13 | - { | |
| 14 | - id: 1, | |
| 15 | - name: "User team 1", | |
| 16 | - path: "user_team1", | |
| 17 | - owner_id: 1 | |
| 18 | - }, | |
| 19 | - { | |
| 20 | - id: 2, | |
| 21 | - name: "User team 2", | |
| 22 | - path: "user_team2", | |
| 23 | - owner_id: 1 | |
| 24 | - } | |
| 25 | -] | |
| 26 | -``` | |
| 27 | - | |
| 28 | - | |
| 29 | -### Get single user team | |
| 30 | - | |
| 31 | -Get a specific user team, identified by user team ID, which is viewable by the authenticated user. | |
| 32 | - | |
| 33 | -``` | |
| 34 | -GET /user_teams/:id | |
| 35 | -``` | |
| 36 | - | |
| 37 | -Parameters: | |
| 38 | - | |
| 39 | -+ `id` (required) - The ID of a user_team | |
| 40 | - | |
| 41 | -```json | |
| 42 | -{ | |
| 43 | - id: 1, | |
| 44 | - name: "User team 1", | |
| 45 | - path: "user_team1", | |
| 46 | - owner_id: 1 | |
| 47 | -} | |
| 48 | -``` | |
| 49 | - | |
| 50 | - | |
| 51 | -### Create user team | |
| 52 | - | |
| 53 | -Creates new user team owned by user. Available only for admins. | |
| 54 | - | |
| 55 | -``` | |
| 56 | -POST /user_teams | |
| 57 | -``` | |
| 58 | - | |
| 59 | -Parameters: | |
| 60 | - | |
| 61 | -+ `name` (required) - new user team name | |
| 62 | -+ `path` (required) - new user team internal name | |
| 63 | - | |
| 64 | - | |
| 65 | - | |
| 66 | -## User team members | |
| 67 | - | |
| 68 | -### List user team members | |
| 69 | - | |
| 70 | -Get a list of project team members. | |
| 71 | - | |
| 72 | -``` | |
| 73 | -GET /user_teams/:id/members | |
| 74 | -``` | |
| 75 | - | |
| 76 | -Parameters: | |
| 77 | - | |
| 78 | -+ `id` (required) - The ID of a user_team | |
| 79 | - | |
| 80 | - | |
| 81 | -### Get user team member | |
| 82 | - | |
| 83 | -Gets a user team member. | |
| 84 | - | |
| 85 | -``` | |
| 86 | -GET /user_teams/:id/members/:user_id | |
| 87 | -``` | |
| 88 | - | |
| 89 | -Parameters: | |
| 90 | - | |
| 91 | -+ `id` (required) - The ID of a user_team | |
| 92 | -+ `user_id` (required) - The ID of a user | |
| 93 | - | |
| 94 | -```json | |
| 95 | -{ | |
| 96 | - id: 2, | |
| 97 | - username: "john_doe", | |
| 98 | - email: "joh@doe.org", | |
| 99 | - name: "John Doe", | |
| 100 | - state: "active", | |
| 101 | - created_at: "2012-10-22T14:13:35Z", | |
| 102 | - access_level: 30 | |
| 103 | -} | |
| 104 | -``` | |
| 105 | - | |
| 106 | - | |
| 107 | -### Add user team member | |
| 108 | - | |
| 109 | -Adds a user to a user team. | |
| 110 | - | |
| 111 | -``` | |
| 112 | -POST /user_teams/:id/members | |
| 113 | -``` | |
| 114 | - | |
| 115 | -Parameters: | |
| 116 | - | |
| 117 | -+ `id` (required) - The ID of a user team | |
| 118 | -+ `user_id` (required) - The ID of a user to add | |
| 119 | -+ `access_level` (required) - Project access level | |
| 120 | - | |
| 121 | - | |
| 122 | -### Remove user team member | |
| 123 | - | |
| 124 | -Removes user from user team. | |
| 125 | - | |
| 126 | -``` | |
| 127 | -DELETE /user_teams/:id/members/:user_id | |
| 128 | -``` | |
| 129 | - | |
| 130 | -Parameters: | |
| 131 | - | |
| 132 | -+ `id` (required) - The ID of a user team | |
| 133 | -+ `user_id` (required) - The ID of a team member | |
| 134 | - | |
| 135 | -## User team projects | |
| 136 | - | |
| 137 | -### List user team projects | |
| 138 | - | |
| 139 | -Get a list of project team projects. | |
| 140 | - | |
| 141 | -``` | |
| 142 | -GET /user_teams/:id/projects | |
| 143 | -``` | |
| 144 | - | |
| 145 | -Parameters: | |
| 146 | - | |
| 147 | -+ `id` (required) - The ID of a user_team | |
| 148 | - | |
| 149 | - | |
| 150 | -### Get user team project | |
| 151 | - | |
| 152 | -Gets a user team project. | |
| 153 | - | |
| 154 | -``` | |
| 155 | -GET /user_teams/:id/projects/:project_id | |
| 156 | -``` | |
| 157 | - | |
| 158 | -Parameters: | |
| 159 | - | |
| 160 | -+ `id` (required) - The ID of a user_team | |
| 161 | -+ `project_id` (required) - The ID of a user | |
| 162 | - | |
| 163 | -```json | |
| 164 | -{ | |
| 165 | - id: 12, | |
| 166 | - name: "project1", | |
| 167 | - description: null, | |
| 168 | - default_branch: "develop", | |
| 169 | - public: false, | |
| 170 | - path: "project1", | |
| 171 | - path_with_namespace: "group1/project1", | |
| 172 | - issues_enabled: false, | |
| 173 | - merge_requests_enabled: true, | |
| 174 | - wall_enabled: true, | |
| 175 | - wiki_enabled: false, | |
| 176 | - created_at: "2013-03-11T12:59:08Z", | |
| 177 | - greatest_access_level: 30 | |
| 178 | -} | |
| 179 | -``` | |
| 180 | - | |
| 181 | - | |
| 182 | -### Add user team project | |
| 183 | - | |
| 184 | -Adds a project to a user team. | |
| 185 | - | |
| 186 | -``` | |
| 187 | -POST /user_teams/:id/projects | |
| 188 | -``` | |
| 189 | - | |
| 190 | -Parameters: | |
| 191 | - | |
| 192 | -+ `id` (required) - The ID of a user team | |
| 193 | -+ `project_id` (required) - The ID of a project to add | |
| 194 | -+ `greatest_access_level` (required) - Maximum project access level | |
| 195 | - | |
| 196 | - | |
| 197 | -### Remove user team project | |
| 198 | - | |
| 199 | -Removes project from user team. | |
| 200 | - | |
| 201 | -``` | |
| 202 | -DELETE /user_teams/:id/projects/:project_id | |
| 203 | -``` | |
| 204 | - | |
| 205 | -Parameters: | |
| 206 | - | |
| 207 | -+ `id` (required) - The ID of a user team | |
| 208 | -+ `project_id` (required) - The ID of a team project | |
| 209 | - |