partner_builds

diff --git a/README.rst b/README.rst
index 0086e9a897a5994d420ab155d29928c3703f261f..5abc28616c50bda9500a181b1ba26a91ffde9517 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -35,6 +35,7 @@ speak with ``devs.ouya.tv``.
 .. include:: api/devs.ouya.tv/api-v1-gamers-me-user_messages.rst
 .. include:: api/devs.ouya.tv/api-v1-games-xxx-purchases.rst
 .. include:: api/devs.ouya.tv/api-v1-games-xxx-purchases.post.rst
+.. include:: api/devs.ouya.tv/api-v1-partner_builds.rst
 .. include:: api/devs.ouya.tv/api-v1-premium_purchases.rst
 .. include:: api/devs.ouya.tv/api-v1-queued_downloads.rst
 .. include:: api/devs.ouya.tv/api-v1-queued_downloads-xxx.delete.rst

diff --git a/api/devs.ouya.tv/api-v1-partner_builds.exit.json b/api/devs.ouya.tv/api-v1-partner_builds.exit.json
new file mode 100644 (file)
index 0000000..706dba9
--- /dev/null
+++ b/api/devs.ouya.tv/api-v1-partner_builds.exit.json
@@ -0,0 +1,7 @@
+{
+    "actions": [
+        {
+            "action": "exit"
+        }
+    ]
+}

diff --git a/api/devs.ouya.tv/api-v1-partner_builds.response.json b/api/devs.ouya.tv/api-v1-partner_builds.response.json
new file mode 100644 (file)
index 0000000..45671e9
--- /dev/null
+++ b/api/devs.ouya.tv/api-v1-partner_builds.response.json
@@ -0,0 +1,38 @@
+{
+    "actions": [
+        {
+            "action": "installFile",
+            "packageName": "tv.ouya.oobe",
+            "friendlyName": "OUYA OOBE",
+            "md5": "41d50891225591fdd32045ed0821a3bf",
+            "filesize": 7725861,
+            "downloadUrl": "http://ouya.cweiske.de/apks/ouya-everywhere/tv.ouya.oobe-1.2.897.apk",
+            "versionCode": 10200897
+        },
+
+        {
+            "action": "installFile",
+            "packageName": "tv.ouya",
+            "friendlyName": "OUYA Framework",
+            "md5": "95d987e7b100c2c72bdac37a8eda2647",
+            "filesize": 3123639,
+            "downloadUrl": "http://ouya.cweiske.de/apks/ouya-everywhere/tv.ouya-1.2.897.apk",
+            "versionCode": 10200897
+        },
+
+        {
+            "action": "installFile",
+            "packageName": "tv.ouya.console",
+            "friendlyName": "OUYA launcher",
+            "md5": "97da25989c64a90c60070978077fff55",
+            "filesize": 18953944,
+            "downloadUrl": "http://ouya.cweiske.de/apks/ouya-everywhere/tv.ouya.console-1.2.897.apk",
+            "versionCode": 10200897
+        },
+
+        {
+            "action": "launch",
+            "packageName": "tv.ouya.console"
+        }
+    ]
+}

diff --git a/api/devs.ouya.tv/api-v1-partner_builds.rst b/api/devs.ouya.tv/api-v1-partner_builds.rst
new file mode 100644 (file)
index 0000000..4e18081
--- /dev/null
+++ b/api/devs.ouya.tv/api-v1-partner_builds.rst
@@ -0,0 +1,143 @@
+==================================================
+``GET https://devs.ouya.tv/api/v1/partner_builds``
+==================================================
+
+Fetch commands for the "OUYA Everywhere" installer.
+
+
+HTTP request
+============
+Protocol
+  ``https``
+Method
+  ``GET``
+Host
+  ``devs.ouya.tv``
+Path
+  ``/api/v1/discover``
+Headers
+  ``User-Agent``
+    ``ouya-everywhere-installer (MadCatz/mojo-TS/mojo:4.2.2/JDQ39/MO0205-TS:user/release-keys)``
+  ``Accept-Language``
+    ``de``
+  ``X-InstallerVersionCode``
+    ??
+  ``X-InstallerVersionName``
+    ??
+  ``X-InstallerPackageName``
+    ??
+  ``X-OUYA-Console-Id``
+    Build serial number
+  ``X-Device``
+    ??
+  ``X-Product``
+    ??
+  ``X-Model``
+    ??
+  ``X-Brand``
+    ??
+  ``X-Display``
+    ??
+  ``X-BuildId``
+    ??
+  ``X-Manufacturer``
+    ??
+  ``OUYAUsername``
+    When logged in.
+
+
+HTTP response
+=============
+Status code
+  ``200 OK``
+Content-type
+  ``application/json; charset=utf-8``
+
+
+Response body definition
+------------------------
+The response is a list of commands that the OUYA Everywhere installer
+will execute one after another.
+
+The top-level object contains a key ``actions``, which is an array of
+action objects.
+Each action has a ``action`` property that defines its type.
+
+
+exit action
+-----------
+Just stop the installer.
+
+No additional properties.
+
+.. include:: api-v1-partner_builds.exit.json
+   :code:
+
+
+installFile action
+------------------
+Install the given .apk file if it has not yet been installed.
+
+``action``
+  ``installFile``
+``packageName``
+  Name of package to install. Example: ``de.ouya.cweiske.foo``
+``friendlyName``
+  Name shown on screen during installation
+``md5``
+  Example: ``d3b07384d113edec49eaa6238ad5ff00``
+``filesize``
+  ``12345``
+``downloadUrl``
+  ``http://example.org/app.apk``
+``versionCode``
+  Optional property. Example: ``23``.
+
+  Only install when the current version is lower than this number.
+
+
+launch action
+-------------
+Start the given application
+
+``action``
+  ``launch``
+``packageName``
+  Application to start. Example: ``de.ouya.cweiske.foo``
+
+
+showDialog action
+-----------------
+Show a message that the user has to confirm.
+
+``action``
+  ``showDialog``
+``title``
+  Message dialog title string
+``message``
+  Actual text
+``verticalMargin``
+  Optional. Example: ``1.0``
+
+
+uninstallFile action
+--------------------
+Remove a package
+
+``action``
+  ``uninstallFile``
+``packageName``
+  Example: ``de.ouya.cweiske.foo``
+``keepData``
+  Optional boolean. Example: ``false``
+``ifLessThanVersionCode``
+  Optional integer. Example: ``12``
+``ifGreaterThanVersionCode``
+  Optional integer. Example: ``42``
+
+
+Example
+-------
+
+.. include:: api-v1-partner_builds.response.json
+   :code: