aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/api.php
diff options
context:
space:
mode:
authorcash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-08-22 19:04:55 +0000
committercash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-08-22 19:04:55 +0000
commitf9ee6f1429f800c3eed3c0ef59d98219be32fba8 (patch)
tree5ddfd5c1cd961465f5c46d4ed07d765275ddee6f /engine/lib/api.php
parent5a396908110b8d9ae358224f15bdbcb9a6c6dfab (diff)
downloadelgg-f9ee6f1429f800c3eed3c0ef59d98219be32fba8.tar.gz
elgg-f9ee6f1429f800c3eed3c0ef59d98219be32fba8.tar.bz2
Merged r6614:6617 from 1.7 branch into trunk
git-svn-id: http://code.elgg.org/elgg/trunk@6845 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib/api.php')
-rw-r--r--engine/lib/api.php5
1 files changed, 3 insertions, 2 deletions
diff --git a/engine/lib/api.php b/engine/lib/api.php
index 0da0c82f0..a3869d262 100644
--- a/engine/lib/api.php
+++ b/engine/lib/api.php
@@ -290,9 +290,10 @@ class ElggHMACCache extends ElggCache {
* "description" => "Some human readable description"
* "function" = 'my_function_callback'
* "parameters" = array (
- * "variable" = array ( // NB, the order should be the same as the function callback
+ * "variable" = array ( // the order should be the same as the function callback
* type => 'int' | 'bool' | 'float' | 'string'
* required => true (default) | false
+ * default => value // optional
* )
* )
* "call_method" = 'GET' | 'POST'
@@ -313,7 +314,7 @@ $API_METHODS = array();
* @param string $method The api name to expose - for example "myapi.dosomething"
* @param string $function Your function callback.
* @param array $parameters (optional) List of parameters in the same order as in your function.
- * Default values may be set for parameters which would allow REST api users flexibility in
+ * Default values may be set for parameters which allow REST api users flexibility in
* what parameters are passed. Generally, optional parameters should be after required parameters.
* This array should be in the format
* "variable" = array (