diff options
| author | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-02-18 11:15:26 +0100 |
|---|---|---|
| committer | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-02-18 11:15:26 +0100 |
| commit | da040fc1348eb7747dd18084a2b12967f7c2b759 (patch) | |
| tree | ee539a72b434d3df3d77ff06bed13bc45443ba42 | |
| parent | beb00af0c16c5b28b60043a6d42e09517ecd2c08 (diff) | |
| download | gitlab-ce-da040fc1348eb7747dd18084a2b12967f7c2b759.tar.gz | |
API documentation expanded with status code information
Information to return codes added to projects and users documentation.
| -rw-r--r-- | doc/api/projects.md | 5 | ||||
| -rw-r--r-- | doc/api/users.md | 13 |
2 files changed, 18 insertions, 0 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index d37d3acf60f..16521917a7a 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -57,6 +57,11 @@ GET /projects ] ``` +Return values: + ++ `200 Ok` on success and a list of projects ++ `401 Unauthorized` if the user is not allowed to access projects + ### Get single project diff --git a/doc/api/users.md b/doc/api/users.md index b94d7c0f789..e5893638fdc 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -43,6 +43,12 @@ GET /users ] ``` +Return values: + ++ `200 Ok` on success and a list with all users ++ `401 Unauthorized` if user is not allowed to access the list + + ## Single user Get a single user. @@ -74,6 +80,13 @@ Parameters: } ``` +Return values: + ++ `200 Ok` on success and the user entry ++ `401 Unauthorized` if it is not allowed to access the user ++ `404 Not Found` if the user with ID is not found + + ## User creation Create user. Available only for admin |
