Browse Source

Update API docs

Kirk Trombley 4 years ago
parent
commit
4f26bcf58f
1 changed files with 5 additions and 5 deletions
  1. 5 5
      README.md

+ 5 - 5
README.md

@@ -31,7 +31,7 @@ GET /caches
         "caches": [
             {
                 "generationMethod": string,
-                "countryLock": string,
+                "countryLock": string || null,
                 "size": number
             }, ...
         ]
@@ -40,18 +40,18 @@ PUT /game
     Accepts {
         "timer": number,
         "rounds": number,
-        "countryLock": string (default: "--"),
+        "countryLock": string || null (default: null),
         "generationMethod": string (default: "MAPCRUNCH"),
         "ruleSet": string (default: "NORMAL")
     }
-    Returns 200 and {
+    Returns 501 vs 200 and {
         "gameId": string
     }
 GET /game/{game_id}/config
     Returns 404 vs 200 and {
         "timer": number,
         "rounds": number,
-        "countryLock": string,
+        "countryLock": string || null,
         "generationMethod": string,
         "ruleSet": string
     }
@@ -100,7 +100,7 @@ GET /game/{game_id}/linked
     Returns 404 vs 200 and {
         "linkedGame": string || null
     }
-POST /game/{game_id}/linked
+PUT /game/{game_id}/linked
     Accepts {
         "linkedGame": string
     }