warricksothr
/
Corvus
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

Adding missing header metadata

master
Drew Short 5 years ago
parent
c8bdc7b30a
commit
e064c4a56b
2 changed files with 7 additions and 7 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      server/documentation/api/authentication.rst
  2. 10
      server/documentation/api/user.rst

4
server/documentation/api/authentication.rst
View File

@ -66,7 +66,7 @@ Authentication API
} }
:<header Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: Encoded token authorization
:<header X-Auth-Token: Encoded token authorization
:>header Content-Type: Depends on :mailheader:`Accept` header of request :>header Content-Type: Depends on :mailheader:`Accept` header of request
:>json datetime lastLoginTime: Updated lastLoginTime for the user :>json datetime lastLoginTime: Updated lastLoginTime for the user
:statuscode 200: User last_login_time successfully bumped :statuscode 200: User last_login_time successfully bumped
@ -98,7 +98,7 @@ Authentication API
} }
:<header Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: Rncoded token authorization
:<header X-Auth-Token: Encoded token authorization
:>header Content-Type: Depends on :mailheader:`Accept` header of request :>header Content-Type: Depends on :mailheader:`Accept` header of request
:>json boolean success: Whether the logout was successful :>json boolean success: Whether the logout was successful
:statuscode 200: User successfully logged out :statuscode 200: User successfully logged out

10
server/documentation/api/user.rst
View File

@ -41,7 +41,7 @@ User API
:query int page: User page to retrieve :query int page: User page to retrieve
:query int perPage: Number of records to retrieve per page (max 100) :query int perPage: Number of records to retrieve per page (max 100)
:<header Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: The encoded basic authorization
:<header X-Auth-Token: Encoded token authorization
:>header Content-Type: Depends on :mailheader:`Accept` header of request :>header Content-Type: Depends on :mailheader:`Accept` header of request
:>json int page: Page retrieved :>json int page: Page retrieved
:>json int count: Number of items returned :>json int count: Number of items returned
@ -85,7 +85,7 @@ User API
:param string user_name: Name of the user to retrieve information about :param string user_name: Name of the user to retrieve information about
:<header Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: The encoded basic authorization
:<header X-Auth-Token: Encoded token authorization
:>header Content-Type: Depends on :mailheader:`Accept` header of request :>header Content-Type: Depends on :mailheader:`Accept` header of request
:>json datetime creationTime: Creation time for the user :>json datetime creationTime: Creation time for the user
:>json datetime lastLoginTime: When the user last logged in, or was last bumped :>json datetime lastLoginTime: When the user last logged in, or was last bumped
@ -133,7 +133,7 @@ User API
:param string user_name: Name of the user to update :param string user_name: Name of the user to update
:<header Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: Encoded token authorization
:<header X-Auth-Token: Encoded token authorization
:<header Content-Type: application/json :<header Content-Type: application/json
:<json datetime createDateTime: Update createDateTime (Administrator Only) :<json datetime createDateTime: Update createDateTime (Administrator Only)
:<json datetime lastLoginTime: Update lastLoginTime :<json datetime lastLoginTime: Update lastLoginTime
@ -187,7 +187,7 @@ User API
} }
:<header Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: Encoded token authorization
:<header X-Auth-Token: Encoded token authorization
:<header Content-Type: application/json :<header Content-Type: application/json
:<json string name: Name of the user :<json string name: Name of the user
:<json string password: Password to use :<json string password: Password to use
@ -229,7 +229,7 @@ User API
:param string user_name: Name of the user to delete :param string user_name: Name of the user to delete
:<header Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: Encoded token authorization
:<header X-Auth-Token: Encoded token authorization
:>header Content-Type: Depends on :mailheader:`Accept` header of request :>header Content-Type: Depends on :mailheader:`Accept` header of request
:>json string message: Success or failure message :>json string message: Success or failure message
:>json boolean success: Action status indicator :>json boolean success: Action status indicator

Write Preview
Loading…
Cancel
Save