Add a new game-info event

[empires-api] / tictactoe.txt

diff --git a/tictactoe.txt b/tictactoe.txt
index 2211a05984ca32d1d30d51eee934f5f7f1d5ec6f..361caf79cd59e27cd4cfead92c83f83bb14b628b 100644 (file)
--- a/tictactoe.txt
+++ b/tictactoe.txt
@@ -26,14 +26,27 @@ For a specific game the following API endpoints are defined.
 
     The following event types will be returned by the server:
 
-        TYPE: game-state
+       TYPE: game-info
 
-        WHEN: When a client first connections
+       WHEN: When a client first connects
+
+       WHAT: Static information about the game (will not change)
 
         EXAMPLE:
 
+               event: game-info
+                data: {"id":"WXYZ","url":"https://lmno.games/WXYZ"}
+
+       TYPE: game-state
+
+       WHEN: When a client first connects
+
+       WHAT: Snapshot of the current dynamic game state
+
+       EXAMPLE:
+
                event: game-state
-                data: {"moves":[0,8],"board":["X","","","","","","","","O"],"next_player":"X"}
+               data: {"moves":[0,8],"board":["X","","","","","","","","O"],"next_player":"X"}
 
        TYPE: move