Skip to content

Commit

Permalink
added documentation to postSession endpoint in identity and facebooki…
Browse files Browse the repository at this point in the history
…dentity
  • Loading branch information
conord33 committed Oct 3, 2013
1 parent 1347f41 commit 1cdd23d
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
23 changes: 22 additions & 1 deletion extensions/FacebookIdentity/controllers/SessionController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
16 changes: 15 additions & 1 deletion extensions/Identity/controllers/SessionController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down

0 comments on commit 1cdd23d

Please sign in to comment.