Add usage information for several endpoints

diff --git a/api/devs.ouya.tv/api-firmware_builds.rst b/api/devs.ouya.tv/api-firmware_builds.rst
index 3c9ad092985106d244ead5850062ddac95a37beb..6236adf6d69164ae45af614ec2ec681cb3e373c6 100644 (file)
--- a/api/devs.ouya.tv/api-firmware_builds.rst
+++ b/api/devs.ouya.tv/api-firmware_builds.rst
@@ -5,6 +5,14 @@
 List the latest available firmware version.
 
 
+Usage
+=====
+
+#. During the OUYA setup (Parameter ``oobe=true`` is set)
+#. During bootup
+#. Every 3 minutes unless an "Expires" header is set
+
+
 HTTP request
 ============
 Protocol
@@ -28,11 +36,9 @@ GET parameters
   ``oobe``
     ``true``
 
-    Can be omitted.
-
-    Does not seem to have any influence on the response.
+    Optional.
 
-    FIXME: what is that for? "Out Of (the) Box Experience"? Does it change anything?
+    Is set once during the OUYA setup (Out Of Box Experience).
 
 
 HTTP response

diff --git a/api/devs.ouya.tv/api-v1-details.rst b/api/devs.ouya.tv/api-v1-details.rst
index 1c3a3682b495933c776ccac6177604e8408e7e71..d504b1bfb9bd57155646f98f3216d04b9a3a9b9e 100644 (file)
--- a/api/devs.ouya.tv/api-v1-details.rst
+++ b/api/devs.ouya.tv/api-v1-details.rst
@@ -39,6 +39,8 @@ GET parameters
     UUID of the developer
 
     Example: ``5b015434-8a78-4274-aa5d-0cb2e330e50e``
+  ``community_content``
+    UUID of a community content module
 
 Only one of ``app``, ``developer`` or ``page`` is provided.
 
@@ -54,6 +56,9 @@ Content-type
 Response body definition
 ------------------------
 
+``ccUrl``
+  Show community content for this game
+
 ``developer.url``
   Not set for everyone.
   If set, a "Developer page" button is shown on the game details screen.

diff --git a/api/devs.ouya.tv/api-v1-gamers-key.put.rst b/api/devs.ouya.tv/api-v1-gamers-key.put.rst
index ce7c74d03b6f66ebd251592eb714d97c5dcbae1d..e22ddeeb103f14949d0c539a547146ad9add3afe 100644 (file)
--- a/api/devs.ouya.tv/api-v1-gamers-key.put.rst
+++ b/api/devs.ouya.tv/api-v1-gamers-key.put.rst
@@ -7,6 +7,15 @@ Store the user's public key on the server.
 Receipts/purchases are encryptd by the server with the user's public key,
 so that only that user can decrypt it.
 
+
+Usage
+=====
+
+#. Once per bootup just before purchases are checked the first time.
+   That can be when opening "Play" that contains purchasable games,
+   or "Discover" showing purchasable games.
+
+
 HTTP request
 ============
 Protocol

diff --git a/api/devs.ouya.tv/api-v1-gamers-me-agreements.put.rst b/api/devs.ouya.tv/api-v1-gamers-me-agreements.put.rst
index 5c6a7f369a1b0aa9595b2c02ddcf584aa571e507..8c64cf0c520777831f6784eb4886eee699cc1201 100644 (file)
--- a/api/devs.ouya.tv/api-v1-gamers-me-agreements.put.rst
+++ b/api/devs.ouya.tv/api-v1-gamers-me-agreements.put.rst
@@ -5,6 +5,14 @@
 Store that a legal agreement has been confirmed by the user.
 
 
+Usage
+=====
+
+#. After setting up a factory-reset OUYA.
+#. After logging in with an existing account.
+#. After booting up the OUYA.
+
+
 HTTP request
 ============
 Protocol
@@ -35,7 +43,7 @@ POST parameters
 HTTP response
 =============
 Status code
-  ``200 OK`` 
+  ``200 OK``
 Content type
   ``application/json; charset=utf-8``
 Body

diff --git a/api/devs.ouya.tv/api-v1-gamers-me-consoles.rst b/api/devs.ouya.tv/api-v1-gamers-me-consoles.rst
index 6dce4257745228ad8100b2a03387a397829656a5..bb7821214ced3c3ce2b6c69b83bed9ad05d4bf24 100644 (file)
--- a/api/devs.ouya.tv/api-v1-gamers-me-consoles.rst
+++ b/api/devs.ouya.tv/api-v1-gamers-me-consoles.rst
@@ -5,6 +5,13 @@
 Associate a console ID with the account.
 
 
+Usage
+=====
+
+#. After logging in with an existing account
+#. (Probably after registering a new account)
+
+
 HTTP request
 ============
 Protocol
@@ -35,7 +42,7 @@ POST parameters
 HTTP response
 =============
 Status code
-  ``200 OK`` 
+  ``200 OK``
 Content type
   ``application/json; charset=utf-8``
 Body

diff --git a/api/devs.ouya.tv/api-v1-gamers.rst b/api/devs.ouya.tv/api-v1-gamers.rst
index 088dae972e15804a36d35e8f82c7b701726625f3..64aceaf79a53ae5cac6b96ca711a7d49f29680b4 100644 (file)
--- a/api/devs.ouya.tv/api-v1-gamers.rst
+++ b/api/devs.ouya.tv/api-v1-gamers.rst
@@ -56,13 +56,15 @@ POST parameters
 HTTP response
 =============
 
+..note:: Does not support HTTP redirects!
+
 Success
 -------
 When everything is ok and the user has been registered
 (or the data were valid when ``dryrun`` was set)
 
 Status code
-  ``200 OK`` 
+  ``200 OK``
 Content type
   ``application/json; charset=utf-8``
 Response body

diff --git a/api/devs.ouya.tv/api-v1-sessions.rst b/api/devs.ouya.tv/api-v1-sessions.rst
index ca4487d3d97e845d05c32b556f6797096a6fadf7..75109a395babdb738cbc7586d819cb402bb613fd 100644 (file)
--- a/api/devs.ouya.tv/api-v1-sessions.rst
+++ b/api/devs.ouya.tv/api-v1-sessions.rst
@@ -14,6 +14,7 @@ Usage
 
 #. After logging with an existing account
 #. After new user registration
+#. When visiting Manage > Accounts
 
 
 HTTP request
@@ -51,7 +52,7 @@ When the user logged in successfully.
           No new token is issued in this case.
 
 Status code
-  ``200 OK`` 
+  ``200 OK``
 Content type
   ``application/json; charset=utf-8``