Platform API Documentation

docs/en_us/platform_api/source/user/accounts.rst

@@ -0,0 +1,39 @@
+##################################################
+User Accounts API Module
+##################################################
+
+This page contains information on using the User Accounts API to
+complete these actions:
+
+* `Get and Update the User's Account Information`_
+
+.. _Get and Update the User's Account Information:
+
+**********************************************
+Get and Update the User's Account Information
+**********************************************
+
+.. autoclass:: user_api.accounts.views.AccountView
+
+**Example response showing the user's account information**
+
+.. code-block:: json
+
+    HTTP 200 OK
+    Content-Type: application/json
+    Vary: Accept
+    Allow: GET, HEAD, OPTIONS, PATCH
+
+    {
+      "username": "John", 
+      "name": "John Doe", 
+      "language": "", 
+      "gender": "m", 
+      "year_of_birth": 2007, 
+      "level_of_education": "m", 
+      "goals": "Professional Development", 
+      "country": US, 
+      "mailing_address": "406 Highland Ave., Somerville, MA 02144", 
+      "email": "johndoe@company.com", 
+      "date_joined": "2015-03-18T13:42:40Z"
+    } 

docs/en_us/platform_api/source/user/endpoints.rst

@@ -0,0 +1,22 @@
+################################################
+User API Endpoints
+################################################
+
+You use the User API to view information about users and update
+your own account.
+
+The following tasks and endpoints are currently supported. 
+
+.. list-table::
+   :widths: 10 70
+   :header-rows: 1
+
+   * - To:
+     - Use this endpoint:
+   * - :ref:`Get a user's account information <Get and Update the User's
+       Account Information>`
+     - GET /api/user/v0/accounts/{username}/[?view=shared]
+   * - :ref:`Update your account information <Get and Update the User's Account
+       Information>`
+     - PATCH /api/user/v0/accounts/{username}/{“key”:”value”} “application
+       /merge-patch+json”

docs/en_us/platform_api/source/user/index.rst

@@ -0,0 +1,12 @@
+.. _edX Platform User API Version 0:
+
+#################################
+User API Version 0
+#################################
+
+.. toctree::
+    :maxdepth: 2
+    
+    overview
+    endpoints
+    accounts

docs/en_us/platform_api/source/user/overview.rst

@@ -0,0 +1,29 @@
+################################################
+User API Overview
+################################################
+
+Use the User API to view and update account information.
+
+You can use the User API for web, desktop, and mobile
+applications.
+
+*************************************
+EdX Platform User API Version 0
+*************************************
+
+The User API is currently at version 0. We plan on making
+significant enhancements to this API.
+
+.. caution::
+ As this is a new and rapidly evolving API, at this time edX does not guarantee
+ forward compatibility. We encourage you to use and experiment with the API,
+ while keeping in mind that endpoints might change.
+
+**********************************************
+User API Capabilities
+**********************************************
+
+With the User API, you can complete these tasks.
+
+* :ref:`Get and update the users' account information <Get and Update the
+  User's Account Information>`