add setup use case

diff --git a/README.rst b/README.rst
index 83c324d99696a82579d03bd1a1cefdfce62c34ae..90b6406a839a67443b173d5ed6d11ae1d7755479 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -8,6 +8,7 @@ gaming console.
 .. contents::
    :depth: 1
 
+.. include:: api/use-cases.rst
 .. include:: api/data.rst
 .. include:: api/headers.rst
 .. include:: api/ping.rst

diff --git a/api/use-cases.rst b/api/use-cases.rst
new file mode 100644 (file)
index 0000000..9d6ad92
--- /dev/null
+++ b/api/use-cases.rst
@@ -0,0 +1,15 @@
+=========
+Use cases
+=========
+
+Setup
+=====
+A new PlayJam GameStick does the following requests:
+
+FIXME verify
+
+OOBE (Out Of Box Experience) process starts with the GameStick setup:
+
+1. Fetch registration code and show it on screen: `POST http://l2.gamestickservices.net/api/rest/connect/stick/stick/xxx/view.json`_
+2. Check every 5 seconds if the online registration has been finished: also `POST http://l2.gamestickservices.net/api/rest/connect/stick/stick/xxx/view.json`_
+3. Download game metadata: also `POST http://l2.gamestickservices.net/api/rest/connect/stick/stick/xxx/view.json`_