X-Git-Url: https://git.cworth.org/git?p=lmno-api;a=blobdiff_plain;f=api.text;h=b1a8f798175a7e89d644c2165a8225c7ff75a62c;hp=250ed107c86aad50698332b5185a5402c85debf2;hb=d25316422d7d9069626b9f09f630155f30534938;hpb=748f60bb7e13cc3422d8d628268d6ee55f1fae83

diff --git a/api.text b/api.text
index 250ed10..b1a8f79 100644
--- a/api.text
+++ b/api.text
@@ -1,6 +1,6 @@
 Empires Game Protocol
 =====================
-Version: 0.4
+Version: 0.5
 
 For a specific game the following API endpoints are defined.
 (Note: Only the trailing portion of the API URI is provided here.
@@ -53,20 +53,25 @@ For a specific game the following API endpoints are defined.
 
 	WHEN: When client first connects and whenever game state changes
 
-	VALUES: Game state will be one of the following:
+	VALUES: Event gives both the old and new state. Game state
+	        Each will be one of the following:
 
-		JOIN: Players are choosing characters and joining the game
-                REVEAL: Character names are being revealed to players
-                CAPTURE: Players are guessing characters in capture attempts
+		none: Pseudo-state used as old_state when game is started
+		join: Players are choosing characters and joining the game
+                reveal: Character names are being revealed to players
+                capture: Players are guessing characters in capture attempts
 
-	EXAMPLE:
+	EXAMPLES:
+
+		event: game-state
+                data: {"old_state":"none","new_state":"join"}
 
 		event: game-state
-                data: {"state":"REVEAL"}
+                data: {"old_state":"join","new_state":"reveal"}
 
 	TYPE: character-reveal
 
-	WHEN: Periodically during the REVEAL state of the game
+	WHEN: Periodically during the "reveal" state of the game
 
 	EXAMPLE: