diff --git a/apiserver/docs/source/api.rst b/apiserver/docs/source/api.rst index f8d87fd..1e759d2 100644 --- a/apiserver/docs/source/api.rst +++ b/apiserver/docs/source/api.rst @@ -893,3 +893,17 @@ Door :param card_number: Usually a 10 character hex string. No authentication required. + + +Ping +---- + +.. http:post:: /ping/ + + Does nothing except check if a user's auth token is still valid. + + :requestheader Authorization: ``Token `` + + **Response** + + :status 200: diff --git a/apiserver/docs/source/apioverview.rst b/apiserver/docs/source/apioverview.rst index 7a859aa..251e36b 100644 --- a/apiserver/docs/source/apioverview.rst +++ b/apiserver/docs/source/apioverview.rst @@ -8,9 +8,6 @@ errors and HTTP response status codes are to designate success and failure. 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 a 301 redirect if you forget it. @@ -52,9 +49,11 @@ Quick Reference .. http:post:: /search/ .. http:get:: /search/(id)/ .. http:get:: /transactions/(id)/ -.. http:post:: /transaction/ +.. http:get:: /transactions/ +.. http:post:: /transactions/ .. http:patch:: /transactions/(id) .. http:put:: /transactions/(id)/ +.. http:post:: /transactions/(id)/report/ .. http:get:: /courses/ .. http:get:: /courses/(id)/ .. http:post:: /courses/ @@ -76,3 +75,4 @@ Quick Reference .. http:delete:: /cards/(id)/ .. http:get:: /door/ .. http:post:: /door/(card_number)/seen/ +.. http:post:: /ping/