updated API Specs

jogli5er · Sep 13, 2014 · bd61ad4 · bd61ad4
1 parent 5dd0359
commit bd61ad4
Show file tree

Hide file tree

Showing 3 changed files with 109 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -32,10 +32,11 @@ Response:
 
     {
         "moves": [
-            { "id": 0, "name": "Column 1" },
-            { "id": 1, "name": "Column 2" },
-            { "id": 2, "name": "Column 3" },
+            { "id": 0, "name": "Column 1" , "usersSelected": integer},
+            { "id": 1, "name": "Column 2" , "usersSelected": integer},
+            { "id": 2, "name": "Column 3" , "usersSelected": integer},
         ],
+        "totalActiveUsers": integer,
         "currentMoveTTL": 23,
         "currentTeamId":"givesUsBackTheCurrentPlayingTeam",
         "isFinished" : false

diff --git a/README.md~ b/README.md~
@@ -0,0 +1,104 @@
+## API Clients-Server
+
+### GET game/join
+
+Response:
+
+    {
+        "teams": [
+            { "id": 0, "name": "red" },
+            { "id": 1, "name": "blue" },
+        ],
+        "currentMoveTTL": INTEGER
+    }
+
+### POST game/join
+
+Data (id of selected Team):
+
+    1
+
+Response:
+
+    {
+        "sessionId": "irgendetwas",
+        "startingTeamId": "givesUsBackTheStartingTeam",
+        "currentMoveTTL": INTEGER
+    }
+
+### GET game/move
+
+Response:
+
+    {
+        "moves": [
+            { "id": 0, "name": "Column 1" },
+            { "id": 1, "name": "Column 2" },
+            { "id": 2, "name": "Column 3" },
+        ],
+        "currentMoveTTL": 23,
+        "currentTeamId":"givesUsBackTheCurrentPlayingTeam",
+        "isFinished" : false
+    }
+
+
+### POST game/move/user/{user_id}
+
+Data (id of selected move):
+
+    2
+
+Response:
+
+    {
+        "moves": [
+            { "id": 0, "name": "Column 1" },
+            { "id": 1, "name": "Column 2" },
+            { "id": 2, "name": "Column 3" },
+        ],
+        "currentMoveTTL": 21
+    }
+
+## Teletext-API
+
+### Spielbrett-Vorschlag
+
+    ======================================
+              T E L E G A M E
+    ======================================
+          It's o's move (not x's)
+
+          1   2   3   4   5   6   7
+        +---+---+---+---+---+---+---+
+        I   I x I   I   I   I   I   I
+        +---+---+---+---+---+---+---+
+        I o I o I   I   I   I   I   I
+        +---+---+---+---+---+---+---+
+        I o I o I   I   I   I   I   I
+        +---+---+---+---+---+---+---+
+        I x I x I x I   I   I   I   I
+        +---+---+---+---+---+---+---+
+        I o I x I o I   I   I x I   I
+        +---+---+---+---+---+---+---+
+        I o I x I o I x I o I o I x I
+        +---+---+---+---+---+---+---+
+        I o I o I o I x I o I o I o I
+        +---+---+---+---+---+---+---+
+
+
+### Zeichen, die von der Teletext-API akteptiert werden:
+!?=_-/+§°"#*'><;.I
+
+### Zeichen, die von der Teletext-API nicht akteptiert werden:
+
+    \ => /
+    | => /
+    @ => §
+    ¬ => -
+    ~ => -
+    [ => <
+    ] => >
+    { => <
+    } => >
+    « => "
+    » => "
diff --git a/frontend/website/js/scripts.js b/frontend/website/js/scripts.js
@@ -56,7 +56,7 @@
                 m = data.moves[i];
                 html += '<button type="button" class="btn btn-primary" data-value="' + m.id + '">' + m.name + '</button>' + "\n";
                 html += '<div class="progress active">';
-                html += '<div class="bar" style="width: '+getPercentages(data.sum, data.moves[i].usersSelected);+';"><span>'+data.moves[i].usersSelected+'</span></div>' //TODO: Check compatibility with backend
+                html += '<div class="bar" style="width: '+getPercentages(data.totalActiveUsers, data.moves[i].usersSelected);+';"><span>'+data.moves[i].usersSelected+'</span></div>' //TODO: Check compatibility with backend
                 html += '</div>'
                 html += '</div>';
             }