Browse Source

Updating authentication header documentation

master
Drew Short 5 years ago
parent
commit
c8bdc7b30a
  1. 4
      server/documentation/api/authentication.rst
  2. 10
      server/documentation/api/user.rst

4
server/documentation/api/authentication.rst

@ -51,7 +51,7 @@ Authentication API
POST /auth/bump HTTP/1.1 POST /auth/bump HTTP/1.1
Host: example.tld Host: example.tld
Accept: application/json Accept: application/json
Authorization: Token <Base64(user:userToken)>
X-Auth-Token: <Base64(user:userToken)>
**Example response**: **Example response**:
@ -83,7 +83,7 @@ Authentication API
POST /auth/logout HTTP/1.1 POST /auth/logout HTTP/1.1
Host: example.tld Host: example.tld
Accept: application/json Accept: application/json
Authorization: Token <Base64(user:userToken)>
X-Auth-Token: <Base64(user:userToken)>
**Example response**: **Example response**:

10
server/documentation/api/user.rst

@ -12,7 +12,7 @@ User API
GET /user HTTP/1.1 GET /user HTTP/1.1
Host: example.tld Host: example.tld
Accept: application/json Accept: application/json
Authorization: Token <Base64(user:userToken)>
X-Auth-Token: <Base64(user:userToken)>
**Example response**: **Example response**:
@ -65,7 +65,7 @@ User API
GET /user/corvus_administrator HTTP/1.1 GET /user/corvus_administrator HTTP/1.1
Host: example.tld Host: example.tld
Accept: application/json Accept: application/json
Authorization: Token <Base64(user:userToken)>
X-Auth-Token: <Base64(user:userToken)>
**Example response**: **Example response**:
@ -107,7 +107,7 @@ User API
PATCH /user/corvus_administrator HTTP/1.1 PATCH /user/corvus_administrator HTTP/1.1
Host: example.tld Host: example.tld
Accept: application/json Accept: application/json
Authorization: Token <Base64(user:userToken)>
X-Auth-Token: <Base64(user:userToken)>
Content-Type: application/json Content-Type: application/json
{ {
@ -162,7 +162,7 @@ User API
POST /user HTTP/1.1 POST /user HTTP/1.1
Host: example.tld Host: example.tld
Accept: application/json Accept: application/json
Authorization: Token <Base64(user:userToken)>
X-Auth-Token: <Base64(user:userToken)>
Content-Type: application/json Content-Type: application/json
{ {
@ -212,7 +212,7 @@ User API
DELETE /user/test_user HTTP/1.1 DELETE /user/test_user HTTP/1.1
Host: example.tld Host: example.tld
Accept: application/json Accept: application/json
Authorization: Token <Base64(user:userToken)>
X-Auth-Token: <Base64(user:userToken)>
**Example response**: **Example response**:

Loading…
Cancel
Save