Browse Source

Minor api updates

Kirk Trombley 5 years ago
parent
commit
aa2b598f3a
2 changed files with 14 additions and 5 deletions
  1. 9 4
      README.md
  2. 5 1
      server/misc_api.py

+ 9 - 4
README.md

@@ -14,6 +14,10 @@ POST /name
         "secret": string
     }
     Returns 400 vs 204, sets session cookie
+GET /valid-session
+    Returns {
+        "valid": boolean
+    }
 PUT /game
     Requires session cookie
     Accepts {
@@ -33,15 +37,16 @@ GET /game/{ID}
                 "lng": number,
             }, ...
         },
-        "guesses": [
+        "players": [
             {
                 "name": string,
+                "currentRound": string || null,
                 "totalScore": number,
                 "guesses": {
                     "1": {
                         "lat": number,
                         "lng": number,
-                        "score": number,
+                        "score": number
                     }, ...
                 }
             }, ...
@@ -55,7 +60,7 @@ GET /game/{ID}/guesses
             "1": {
                 "lat": number,
                 "lng": number,
-                "score": number,
+                "score": number
             }, ...
         }
     }
@@ -63,7 +68,7 @@ POST /game/{ID}/guesses/{round}
     Requires session cookie
     Accepts {
         "lat": number,
-        "lng": number,
+        "lng": number
     }
     Returns 400 vs 201
 ```

+ 5 - 1
server/misc_api.py

@@ -19,4 +19,8 @@ def name():
         abort(400)
 
     session["name"] = name
-    return "", 204
+    return "", 204
+
+@misc.route("/valid-session")
+def valid_session():
+    return jsonify({"valid": ("name" in session)})