Add /ping/ route to docs

This commit is contained in:
Tanner Collin 2020-02-04 08:39:26 +00:00
parent 3565bddf8d
commit 51b6be93cc
2 changed files with 18 additions and 4 deletions

View File

@ -893,3 +893,17 @@ Door
:param card_number: Usually a 10 character hex string. :param card_number: Usually a 10 character hex string.
No authentication required. No authentication required.
Ping
----
.. http:post:: /ping/
Does nothing except check if a user's auth token is still valid.
:requestheader Authorization: ``Token <token>``
**Response**
:status 200:

View File

@ -8,9 +8,6 @@ errors and HTTP response status codes are to designate success and failure.
Request bodies can be JSON or form data. Request bodies can be JSON or form data.
API Routes
----------
All API routes require a trailing slash. This is a Django default and you'll get All API routes require a trailing slash. This is a Django default and you'll get
a 301 redirect if you forget it. a 301 redirect if you forget it.
@ -52,9 +49,11 @@ Quick Reference
.. http:post:: /search/ .. http:post:: /search/
.. http:get:: /search/(id)/ .. http:get:: /search/(id)/
.. http:get:: /transactions/(id)/ .. http:get:: /transactions/(id)/
.. http:post:: /transaction/ .. http:get:: /transactions/
.. http:post:: /transactions/
.. http:patch:: /transactions/(id) .. http:patch:: /transactions/(id)
.. http:put:: /transactions/(id)/ .. http:put:: /transactions/(id)/
.. http:post:: /transactions/(id)/report/
.. http:get:: /courses/ .. http:get:: /courses/
.. http:get:: /courses/(id)/ .. http:get:: /courses/(id)/
.. http:post:: /courses/ .. http:post:: /courses/
@ -76,3 +75,4 @@ Quick Reference
.. http:delete:: /cards/(id)/ .. http:delete:: /cards/(id)/
.. http:get:: /door/ .. http:get:: /door/
.. http:post:: /door/(card_number)/seen/ .. http:post:: /door/(card_number)/seen/
.. http:post:: /ping/