]> git.cworth.org Git - empires-api/commitdiff
Add a version indication to the protocol description
authorCarl Worth <cworth@cworth.org>
Sun, 10 May 2020 16:53:16 +0000 (09:53 -0700)
committerCarl Worth <cworth@cworth.org>
Sun, 10 May 2020 16:53:16 +0000 (09:53 -0700)
Starting with version 0.3 since there have been a couple of previosu
versions, (but also less than 1.0 since we haven't yet implemented a
functional game).

api.text

index 48a2eb6b072c499795d0d81a9451ce59ff37ee01..41e365c65e3df41a6151cda5d057e956c1bb52f3 100644 (file)
--- a/api.text
+++ b/api.text
@@ -1,5 +1,11 @@
-Gameplay API endpoints (within a current game)
-==============================================
+Empires Game Protocol
+=====================
+Version: 0.3
+
+For a specific game the following API endpoints are defined.
+(Note: Only the trailing portion of the API URI is provided here.
+ The preceding portions of the path must be determined externally.)
+
 /events
 
     This is a server-sent events stream that allows the server to push