Make project users API more RESTful

This commit is contained in:
miks 2012-09-06 23:49:29 +03:00
parent 2dc0519277
commit 909c8c345d
4 changed files with 111 additions and 8 deletions

View file

@ -106,12 +106,26 @@ Parameters:
Will return created project with status `201 Created` on success, or `404 Not
found` on fail.
## Get project users
Get users and access roles for existing project
```
GET /projects/:id/users
```
Parameters:
+ `id` (required) - The ID or code name of a project
Will return users and their access roles with status `200 OK` on success, or `404 Not found` on fail.
## Add project users
Add users to exiting project
```
PUT /projects/:id/add_users
POST /projects/:id/users
```
Parameters:
@ -120,7 +134,38 @@ Parameters:
+ `user_ids` (required) - The ID list of users to add
+ `project_access` (required) - Project access level
Will return updated project with status `200 OK` on success, or `404 Not found` on fail.
Will return status `201 Created` on success, or `404 Not found` on fail.
## Update project users access level
Update existing users to specified access level
```
PUT /projects/:id/users
```
Parameters:
+ `id` (required) - The ID or code name of a project
+ `user_ids` (required) - The ID list of users to add
+ `project_access` (required) - Project access level
Will return status `200 OK` on success, or `404 Not found` on fail.
## Delete project users
Delete users from exiting project
```
DELETE /projects/:id/users
```
Parameters:
+ `id` (required) - The ID or code name of a project
+ `user_ids` (required) - The ID list of users to add
Will return status `200 OK` on success, or `404 Not found` on fail.
## Project repository branches