Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Tango API documentation #2153

Open
damianhxy opened this issue May 1, 2024 · 0 comments
Open

Update Tango API documentation #2153

damianhxy opened this issue May 1, 2024 · 0 comments

Comments

@damianhxy
Copy link
Member

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
  • open endpoint: 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 courselab is. It's 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)
  • inconsistency: info and jobs titles have slashes while the endpoint titles don't
  • inconsistency: info endpoint is the only one that uses <KEY> to indicate that key is a variable
  • inconsistency: some endpoints use empty to indicate empty request bodies, other endpoints use { <empty> }
  • inconsistency: jobs endpoint has extraneous autograde.me in URL
  • jobs endpoint: should be made clear that deadjobs should be an integer, either 0 or 1. Also, it's a GET method, not POST method
  • pool endpoint: missing description of request body (empty). Could also mention that omitting image would show all pools.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant