Add usage information for several endpoints
[ouya-store-api.git] / api / devs.ouya.tv / api-v1-gamers.rst
index 5d79b26cd00745a4d274cf1873b1028467180d1e..64aceaf79a53ae5cac6b96ca711a7d49f29680b4 100644 (file)
@@ -8,6 +8,12 @@ This method is both used as verification during input, as well as the
 final registration.
 
 
+Usage
+=====
+#. During registration to check if data are valid
+#. During registration to finish new user sign up and create the account
+
+
 HTTP request
 ============
 Protocol
@@ -50,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
@@ -73,5 +81,5 @@ Content type
 
 Example:
 
-.. include:: api-v1-gamers-response-invalid.json
+.. include:: api-v1-gamers.response-invalid.json
    :code: