aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-02-07 18:46:36 +0000
committercash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-02-07 18:46:36 +0000
commita70e447b30c3469f6ba0f973016dd2c8e94fd7a4 (patch)
treef1d953fc59a6cae4f2794e6501ba9092f2f8e64b
parente3b170d9b0f433f427a095e847326d572e54a6ff (diff)
downloadelgg-a70e447b30c3469f6ba0f973016dd2c8e94fd7a4.tar.gz
elgg-a70e447b30c3469f6ba0f973016dd2c8e94fd7a4.tar.bz2
tweaked some documentation on the REST API
git-svn-id: http://code.elgg.org/elgg/trunk@3918 36083f99-b078-4883-b0ff-0f9b5a30f544
-rw-r--r--engine/lib/api.php8
-rw-r--r--languages/en.php2
2 files changed, 5 insertions, 5 deletions
diff --git a/engine/lib/api.php b/engine/lib/api.php
index 9fbca5714..4bbd24969 100644
--- a/engine/lib/api.php
+++ b/engine/lib/api.php
@@ -1204,7 +1204,7 @@ function serialise_api_headers(array $headers) {
* @param string $method GET or POST
* @param string $post_data The post data
* @param string $content_type The content type
- * @return stdClass The unserialised response object
+ * @return string
*/
function send_api_call(array $keys, $url, array $call, $method = 'GET', $post_data = '', $content_type = 'application/octet-stream') {
global $CONFIG;
@@ -1293,7 +1293,7 @@ function send_api_call(array $keys, $url, array $call, $method = 'GET', $post_da
* @param string $url URL of the endpoint.
* @param array $call Associated array of "variable" => "value"
* @param array $keys The keys dependant on chosen authentication method
- * @return stdClass The unserialised response object
+ * @return string
*/
function send_api_get_call($url, array $call, array $keys) {
return send_api_call($keys, $url, $call);
@@ -1307,7 +1307,7 @@ function send_api_get_call($url, array $call, array $keys) {
* @param array $keys The keys dependant on chosen authentication method
* @param string $post_data The post data
* @param string $content_type The content type
- * @return stdClass The unserialised response object
+ * @return string
*/
function send_api_post_call($url, array $call, array $keys, $post_data, $content_type = 'application/octet-stream') {
return send_api_call($keys, $url, $call, 'POST', $post_data, $content_type);
@@ -1342,7 +1342,7 @@ function list_all_apis() {
/**
* The auth.gettoken API.
* This API call lets a user log in, returning an authentication token which can be used
- * in leu of a username and password login for a specific period of time.
+ * to authenticate a user for a period of time.
*
* @param string $username Username
* @param string $password Clear text password
diff --git a/languages/en.php b/languages/en.php
index 7310c8ac2..4833ec355 100644
--- 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 log in, returning an authentication token which can be used in leu of a username and password for authenticating further calls.",
+ 'auth.gettoken' => "This API call lets a user obtain an authentication token which can be used for authenticating future API calls.",
/**
* User details