Download as
Browse Code »

Commit da040fc1348eb7747dd18084a2b12967f7c2b759

Authored by Sebastian Ziebell
1 parent beb00af0
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

API documentation expanded with status code information 

Information to return codes added to projects and users documentation.
Showing 2 changed files with 18 additions and 0 deletions   Show diff stats
doc/api/projects.md
  Diff comments   View file @da040fc
@@ -57,6 +57,11 @@ GET /projects @@ -57,6 +57,11 @@ GET /projects
57 ] 57 ]
58 ``` 58 ```
59 59
  60 +Return values:
  61 +
  62 ++ `200 Ok` on success and a list of projects
  63 ++ `401 Unauthorized` if the user is not allowed to access projects
  64 +
60 65
61 ### Get single project 66 ### Get single project
62 67
doc/api/users.md
  Diff comments   View file @da040fc
@@ -43,6 +43,12 @@ GET /users @@ -43,6 +43,12 @@ GET /users
43 ] 43 ]
44 ``` 44 ```
45 45
  46 +Return values:
  47 +
  48 ++ `200 Ok` on success and a list with all users
  49 ++ `401 Unauthorized` if user is not allowed to access the list
  50 +
  51 +
46 ## Single user 52 ## Single user
47 53
48 Get a single user. 54 Get a single user.
@@ -74,6 +80,13 @@ Parameters: @@ -74,6 +80,13 @@ Parameters:
74 } 80 }
75 ``` 81 ```
76 82
  83 +Return values:
  84 +
  85 ++ `200 Ok` on success and the user entry
  86 ++ `401 Unauthorized` if it is not allowed to access the user
  87 ++ `404 Not Found` if the user with ID is not found
  88 +
  89 +
77 ## User creation 90 ## User creation
78 Create user. Available only for admin 91 Create user. Available only for admin
79 92