Merge pull request #12 from conord33/docs/postSession

added documentation to postSession endpoint in identity and facebookiden...
prolificinteractive · Oct 3, 2013 · 21d9aa1 · 21d9aa1
2 parents 22bce21 + 1cdd23d
commit 21d9aa1
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/extensions/FacebookIdentity/controllers/SessionController.php b/extensions/FacebookIdentity/controllers/SessionController.php
@@ -131,7 +131,28 @@ protected function insertFBUser($fbData) {
    * If a Facebook accessToken is used and the user does not exist already in the API, a new user will be automatically
    * created and the returning newUserCreated field will be true.
    *
-   * @docs-param session string body required A session object (with email & password or accessToken filled in)
+   * ~~~
+   * Get sessions through email password
+   * {
+   *     "email": string,
+   *     "password": string
+   * }
+   *
+   * or get one time session to reset password
+   *
+   * {
+   *     "email": string,
+   *     "authToken": string
+   * }
+   *
+   * or get session through facebook access token
+   *
+   * {
+   *     "accessToken": string
+   * }
+   * ~~~
+   *
+   * @docs-param session string body required A session object (with email & password or email & authToken or accessToken filled in)
    *
    * @throws \Slim\Exception\Stop
    */

diff --git a/extensions/Identity/controllers/SessionController.php b/extensions/Identity/controllers/SessionController.php
@@ -37,7 +37,21 @@ class SessionController extends RESTModelController {
    * Creates a session. A valid email and password of an existing user must be passed in, and the new session
    * (with the session id) will be returned.
    *
-   * @docs-param session string body required A session object (with email & password filled in)
+   * ~~~
+   * Get sessions through email password
+   * {
+   *     "email": string,
+   *     "password": string
+   * }
+   *
+   * or get one time session to reset password
+   *
+   * {
+   *     "email": string,
+   *     "authToken": string
+   * }
+   *
+   * @docs-param session string body required A session object (with email & password or email & authToken filled in)
    *
    * @throws \Slim\Exception\Stop
    */