Document ssh key creation error

Add the error code returned in the headers as well as an example of the JSON informative message returned in the body. Signed-off-by: Loic Dachary <loic@dachary.org>

Document ssh key creation error
d9b946fb · Loic Dachary · 201b2f10 · d9b946fb
Commit d9b946fb authored Jan 21, 2015 by Loic Dachary
Hide whitespace changes
Inline Side-by-side

Showing with 16 additions and 0 deletions

users.md doc/api/users.md +16 -0

No files found.
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -331,6 +331,22 @@ Parameters:
 }
 ```

+Will return created key with status `201 Created` on success. If an
+error occurs a `400 Bad Request` is returned with a message explaining the error:
+
+```json
+{
+  "message": {
+    "fingerprint": [
+      "has already been taken"
+    ],
+    "key": [
+      "has already been taken"
+    ]
+  }
+}
+```
+
 ## Add SSH key for user

 Create new key owned by specified user. Available only for admin