Add usage information for several endpoints

[ouya-store-api.git] / api / devs.ouya.tv / api-v1-details.rst

diff --git a/api/devs.ouya.tv/api-v1-details.rst b/api/devs.ouya.tv/api-v1-details.rst
index 724c156bb663a75b64b1f761cb62740b4af542a7..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.
 
@@ -50,8 +52,36 @@ Status code
 Content-type
   ``application/json; charset=utf-8``
 
+
+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.
+
+  Example when set: ``ouya://launcher/details?developer=92345f8d-ddbd-43f2-afcf-2628b1234713``
+
+``metaData``
+  Array of strings that determine which data are shown in the top row.
+
+  Allowed values:
+
+  - ``key:rating.average``: Shows the rating stars from ``rating.average``
+  - ``key:apk.fileSize``: Shows the ``apk.fileSize`` as readable size with unit.
+  - ``key:twitterHandle``: Shows the ``twitterHandle`` property, automatically prefixes an "@".
+  - Any string value beginning with "key:" fetches the key path from JSON, e.g. ``developer.name``.
+  - Any string value that does not begin with ``key:`` is shown as-is.
+
+``promotedProduct``
+  When set, the "Buy" button is shown on the details screen.
+
+
 Example: App
----------------
+------------
 
 .. include:: api-v1-details.response-app.json
    :code: