updated documentation on the REST API user authentication

git-svn-id: http://code.elgg.org/elgg/trunk@3933 36083f99-b078-4883-b0ff-0f9b5a30f544

diff --git a/engine/lib/api.php b/engine/lib/api.php
index 4fd474de7b359fe83ff22cee9f2cf0e7ce145f12..ffb1e16afab2f9f2adfe99ce3dfbc1bbc6601c8a 100644 (file)
--- a/engine/lib/api.php
+++ b/engine/lib/api.php
@@ -1342,7 +1342,8 @@ function list_all_apis() {
 /**
  * The auth.gettoken API.
  * This API call lets a user log in, returning an authentication token which can be used
- * to authenticate a user for a period of time.
+ * to authenticate a user for a period of time. It is passed in future calls as the parameter 
+ * auth_token.
  *
  * @param string $username Username
  * @param string $password Clear text password

diff --git a/languages/en.php b/languages/en.php
index c22962d9b263bb348ffc5a4ae2b8d1bcb087f094..47661501fcceba10dc9abc2e7d399f6f403a1f13 100644 (file)
--- a/languages/en.php
+++ b/languages/en.php
@@ -188,7 +188,7 @@ $english = array(
  * API
  */
        'system.api.list' => "List all available API calls on the system.",
-       'auth.gettoken' => "This API call lets a user obtain an authentication token which can be used for authenticating future API calls.",
+       'auth.gettoken' => "This API call lets a user obtain a user authentication token which can be used for authenticating future API calls. Pass it as the parameter auth_token",
 
 /**
  * User details