Browse Source

Updating the user api documentation to have the correct success meanings

merge-requests/6/head
Drew Short 6 years ago
parent
commit
9168fa9ca0
  1. 8
      server/documentation/api/user.rst

8
server/documentation/api/user.rst

@ -33,7 +33,7 @@ User API
:reqheader Accept: the response content type depends on :mailheader:`Accept` header
:reqheader Authorization: The encoded basic authorization
:resheader Content-Type: this depends on :mailheader:`Accept` header of request
:statuscode 200: user successfully logged in
:statuscode 200: successfully retrieved the user
:statuscode 401: authorization failed
:statuscode 404: user doesn't exist
@ -76,7 +76,7 @@ User API
:reqheader Authorization: The encoded basic authorization
:reqheader Content-Type: application/json
:resheader Content-Type: this depends on :mailheader:`Accept` header of request
:statuscode 200: user successfully logged in
:statuscode 200: successfully patched the user
:statuscode 400: an issue in the payload was discovered
:statuscode 401: authorization failed
:statuscode 404: user doesn't exist
@ -120,7 +120,7 @@ User API
:reqheader Authorization: The encoded basic authorization
:reqheader Content-Type: application/json
:resheader Content-Type: this depends on :mailheader:`Accept` header of request
:statuscode 200: user successfully logged in
:statuscode 200: successfully registered the user
:statuscode 400: an issue in the payload was discovered
:statuscode 401: authorization failed
@ -153,6 +153,6 @@ User API
:reqheader Accept: the response content type depends on :mailheader:`Accept` header
:reqheader Authorization: The encoded basic authorization
:resheader Content-Type: this depends on :mailheader:`Accept` header of request
:statuscode 200: user successfully logged in
:statuscode 200: successfully deleted the user
:statuscode 401: authorization failed
:statuscode 404: user doesn't exist
Loading…
Cancel
Save