diff options
author | miks <miks@cubesystems.lv> | 2012-09-07 00:49:29 +0400 |
---|---|---|
committer | miks <miks@cubesystems.lv> | 2012-09-07 00:49:29 +0400 |
commit | 909c8c345dff0851e15d81917efe7817c7f89e22 (patch) | |
tree | 4956244a32cce076eb0aa5d1f614bdf7c042faa0 /doc/api | |
parent | 2dc0519277417456372d6bde5c47bec895cc497e (diff) |
Make project users API more RESTful
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/projects.md | 49 |
1 files changed, 47 insertions, 2 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index 972ea67ed3c..b26305b140f 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -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 |