diff options
| author | Felix Gilcher <felix.gilcher@asquera.de> | 2013-01-28 23:51:45 +0100 |
|---|---|---|
| committer | Felix Gilcher <felix.gilcher@asquera.de> | 2013-01-28 23:51:45 +0100 |
| commit | e76215a395bb814972c1385ce815b2da2a6e3402 (patch) | |
| tree | 98b27be9d042cd7e626c7b624ae1cded731f32d1 /doc/api | |
| parent | a90d5c21b55584572ff22d7a3affd84cd19d38d2 (diff) | |
| download | gitlab-ce-e76215a395bb814972c1385ce815b2da2a6e3402.tar.gz | |
Update docs to reflect that project names are allowed as ID
The API accepts project names in all places where project IDs are expected. Updated the docs to
reflect that.
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/projects.md | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index e8730173c0a..64d79a0d51b 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -53,7 +53,8 @@ GET /projects ## Single project -Get a specific project, identified by project ID, which is owned by the authentication user. +Get a specific project, identified by project ID or NAME, which is owned by the authentication user. +Currently namespaced projects cannot retrieved by name. ``` GET /projects/:id @@ -61,7 +62,7 @@ GET /projects/:id Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project ```json { @@ -129,7 +130,7 @@ GET /projects/:id/members Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `query` - Query string ## Get project team member @@ -142,7 +143,7 @@ GET /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `user_id` (required) - The ID of a user ```json @@ -168,7 +169,7 @@ POST /projects/:id/members Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `user_id` (required) - The ID of a user to add + `access_level` (required) - Project access level @@ -184,7 +185,7 @@ PUT /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `user_id` (required) - The ID of a team member + `access_level` (required) - Project access level @@ -200,7 +201,7 @@ DELETE /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `user_id` (required) - The ID of a team member Status code `200` will be returned on success. @@ -215,7 +216,7 @@ GET /projects/:id/hooks Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project Will return hooks with status `200 OK` on success, or `404 Not found` on fail. @@ -229,7 +230,7 @@ GET /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `hook_id` (required) - The ID of a project hook Will return hook with status `200 OK` on success, or `404 Not found` on fail. @@ -244,7 +245,7 @@ POST /projects/:id/hooks Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `url` (required) - The hook URL Will return status `201 Created` on success, or `404 Not found` on fail. @@ -259,7 +260,7 @@ PUT /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `hook_id` (required) - The ID of a project hook + `url` (required) - The hook URL @@ -276,7 +277,7 @@ DELETE /projects/:id/hooks Parameters: -+ `id` (required) - The ID of a project ++ `id` (required) - The ID or NAME of a project + `hook_id` (required) - The ID of hook to delete Will return status `200 OK` on success, or `404 Not found` on fail. |