Add GET user endpoint doc

examples/README.md

@@ -20,7 +20,7 @@ request. A Token can be acquired from the Login view above.
 Each endpoint manipulates or displays information related to the User whose
 Token is provided with the request:
 
-* [TODO Show info](user/get.md) : `GET /api/user/`
+* [Show info](user/get.md) : `GET /api/user/`
 * [TODO Update info](user/put.md) : `PUT /api/user/`
 
 ### Account related

examples/user/get.md

@@ -0,0 +1,46 @@
+# Show Current User
+
+Get the details of the currently Authenticated User along with basic
+subscription information.
+
+**URL** : `/api/user/`
+
+**Method** : `GET`
+
+**Auth required** : YES
+
+**Permissions required** : None
+
+## Success Response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+For a User with ID 1234 on the local database where that User has saved an
+email address and name information.
+
+```json
+{
+    "id": 1234,
+    "first_name": "Joe",
+    "last_name": "Bloggs",
+    "email": "[email protected]"
+}
+```
+
+For a user with ID 4321 on the local database but no details have been set yet.
+
+```json
+{
+    "id": 4321,
+    "first_name": "",
+    "last_name": "",
+    "email": ""
+}
+```
+
+## Notes
+
+* If the User does not have a `UserInfo` instance when requested then one will
+  be created for them.