diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2017-09-06 10:15:34 +0300 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2017-09-06 10:15:34 +0300 |
| commit | 4dff341af11d651d1ec199d35eebaf4adb92fdd0 (patch) | |
| tree | 16af980ef39a2aae283fa4ed1b747bad89456b71 /doc/api/users.md | |
| parent | 745bc35666ce7e6cc3fbdb08596e4e18a35f8e04 (diff) | |
Fix wrong API status codes
Diffstat (limited to 'doc/api/users.md')
| -rw-r--r-- | doc/api/users.md | 15 |
1 files changed, 3 insertions, 12 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index 57b4e117cf3..9f3e4caf2f4 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -299,10 +299,7 @@ e.g. when renaming the email address to some existing one. ## User deletion Deletes a user. Available only for administrators. -This is an idempotent function, calling this function for a non-existent user id -still returns a status code `200 OK`. -The JSON response differs if the user was actually deleted or not. -In the former the user is returned and in the latter not. +This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found. ``` DELETE /users/:id @@ -524,8 +521,7 @@ Parameters: ## Delete SSH key for current user Deletes key owned by currently authenticated user. -This is an idempotent function and calling it on a key that is already deleted -or not available results in `200 OK`. +This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found. ``` DELETE /user/keys/:key_id @@ -548,8 +544,6 @@ Parameters: - `id` (required) - id of specified user - `key_id` (required) - SSH key ID -Will return `200 OK` on success, or `404 Not found` if either user or key cannot be found. - ## List all GPG keys Get a list of currently authenticated user's GPG keys. @@ -865,8 +859,7 @@ Parameters: ## Delete email for current user Deletes email owned by currently authenticated user. -This is an idempotent function and calling it on a email that is already deleted -or not available results in `200 OK`. +This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found. ``` DELETE /user/emails/:email_id @@ -889,8 +882,6 @@ Parameters: - `id` (required) - id of specified user - `email_id` (required) - email ID -Will return `200 OK` on success, or `404 Not found` if either user or email cannot be found. - ## Block user Blocks the specified user. Available only for admin. |