Browse Source

Designing a new score check endpoint

Kirk Trombley 5 years ago
parent
commit
4175d6c110
1 changed files with 17 additions and 2 deletions
  1. 17 2
      README.md

+ 17 - 2
README.md

@@ -15,9 +15,24 @@ GET /
         "version": string,
         "status": string
     }
+POST /score
+    Accepts {
+        "point1": {
+            "lat": number,
+            "lng": number
+        },
+        "point2": {
+            "lat": number,
+            "lng": number
+        }
+    }
+    Returns 200 and {
+        "score": number,
+        "distance": number
+    }
 PUT /game
     Accepts {
-        "timer": number
+        "timer": number,
         "rounds": number
     }
     Returns 200 and {
@@ -83,7 +98,7 @@ POST /game/{ID}/guesses/{round}
     Returns (400, 401, 404, 409) vs 201 and {
         "score": number,
         "totalScore": number,
-        "distance": number || null,
+        "distance": number || null
     }
 ```