- 
                Notifications
    You must be signed in to change notification settings 
- Fork 232
Open
Description
There are several inadequacies with the current documentation:
- Should be made clear what keyrefers to - Tango reads theRESTFUL_KEYenv var (or usestestas a default). For docker installs, it's set by the.envfile
- It should then be made clear in all the request headers that keyis a variable, not verbatim
- openendpoint: currently always returns a empty dict (see Return MD5 of existing files on open Tango#145 for context)
- Should be made clear what the value of courselabis. It seems to be of the format<course name>-<asmt name>
- pollendpoint:- outputFileis a variable whose value is of the form- <user email>_<ver>_<assessment name>_autograde.txt(uri-encoded)
- inconsistency: infoandjobstitles have slashes while the endpoint titles don't
- inconsistency: infoendpoint is the only one that uses<KEY>to indicate thatkeyis a variable
- inconsistency: some endpoints use emptyto indicate empty request bodies, other endpoints use{ <empty> }
- inconsistency: jobsendpoint has extraneousautograde.mein URL
- jobsendpoint: should be made clear that- deadjobsshould be an integer, either 0 or 1. Also, it's a- GETmethod, not- POSTmethod
- poolendpoint: missing description of request body (empty). Could also mention that omitting- imagewould show all pools.