neale/moth
neale
/
moth
mirror of https://github.com/dirtbags/moth.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Document all parameters

This commit is contained in:
Neale Pickett 2018-05-23 17:37:29 +00:00
parent ede420ab9b
commit da2caa247d
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/api.md
View File

@ -96,6 +96,11 @@ GetPuzzle(category, points)
Return a puzzle. Return a puzzle.
Parameters:
* category: name of category to fetch from
* points: point value of the puzzle to fetch
Return data: Return data:
* authors: List of puzzle authors * authors: List of puzzle authors
@ -158,6 +163,13 @@ SubmitAnswer(teamId, category, points, answer)
Submit an answer to a puzzle. Submit an answer to a puzzle.
Parameters:
* teamId: Team ID (optional: if ommitted, answer is verified but no points are awarded)
* category: category name of puzzle
* points: point value of puzzle
* answer: attempted answer
Example: Example:
https://server/SubmitAnswer?teamId=8b1292ca&category=sequence&points=1&answer=6 https://server/SubmitAnswer?teamId=8b1292ca&category=sequence&points=1&answer=6
@ -172,6 +184,11 @@ SubmitToken(teamId, token)
Submit a token for points Submit a token for points
Parameters:
* teamId: Team ID
* token: Token being submitted
Return data: Return data:
* category: category for which this token awarded points * category: category for which this token awarded points