From da2caa247d05f02e9aa6c515e6d1b388b90eb109 Mon Sep 17 00:00:00 2001
From: Neale Pickett <neale@lanl.gov>
Date: Wed, 23 May 2018 17:37:29 +0000
Subject: [PATCH] Document all parameters

---
 docs/api.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/api.md b/docs/api.md
index 3584d6b..25a6536 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -96,6 +96,11 @@ GetPuzzle(category, points)
 
 Return a puzzle.
 
+Parameters:
+
+* category: name of category to fetch from
+* points: point value of the puzzle to fetch
+
 Return data:
 
 * authors: List of puzzle authors
@@ -158,6 +163,13 @@ SubmitAnswer(teamId, category, points, answer)
 
 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:
 
     https://server/SubmitAnswer?teamId=8b1292ca&category=sequence&points=1&answer=6
@@ -172,6 +184,11 @@ SubmitToken(teamId, token)
 
 Submit a token for points
 
+Parameters:
+
+* teamId: Team ID
+* token: Token being submitted
+
 Return data:
 
 * category: category for which this token awarded points