There are several inadequacies with the current documentation:
Should be made clear what key refers to - Tango reads the RESTFUL_KEY env var (or uses test as a default). For docker installs, it's set by the .env file
It should then be made clear in all the request headers that key is a variable, not verbatim
There are several inadequacies with the current documentation:
key
refers to - Tango reads theRESTFUL_KEY
env var (or usestest
as a default). For docker installs, it's set by the.env
filekey
is a variable, not verbatimopen
endpoint: currently always returns a empty dict (see https://github.com/autolab/Tango/pull/145 for context)courselab
is. It seems to be of the format<course name>-<asmt name>
poll
endpoint:outputFile
is a variable whose value is of the form<user email>_<ver>_<assessment name>_autograde.txt
(uri-encoded)info
andjobs
titles have slashes while the endpoint titles don'tinfo
endpoint is the only one that uses<KEY>
to indicate thatkey
is a variableempty
to indicate empty request bodies, other endpoints use{ <empty> }
jobs
endpoint has extraneousautograde.me
in URLjobs
endpoint: should be made clear thatdeadjobs
should be an integer, either 0 or 1. Also, it's aGET
method, notPOST
methodpool
endpoint: missing description of request body (empty). Could also mention that omittingimage
would show all pools.