summaryrefslogtreecommitdiffstats
path: root/web/html/rpc.php
diff options
context:
space:
mode:
Diffstat (limited to 'web/html/rpc.php')
-rw-r--r--web/html/rpc.php17
1 files changed, 15 insertions, 2 deletions
diff --git a/web/html/rpc.php b/web/html/rpc.php
index 3081391..033cba5 100644
--- a/web/html/rpc.php
+++ b/web/html/rpc.php
@@ -10,9 +10,22 @@ if ( $_SERVER['REQUEST_METHOD'] == 'GET' ) {
if ( isset($_GET['type']) ) {
echo $rpc_o->handle($_GET);
}
- else {
+ else {
+ // dump a simple usage output for people to use.
+ // this could be moved to an api doc in the future, or generated from
+ // the AurJSON class directly with phpdoc. For now though, just putting it here.
echo '<html><body>';
- echo $rpc_o->usage();
+ echo 'The methods currently allowed are: <br />';
+ echo '<ul>';
+ echo '<li>search</li>';
+ echo '<li>info</li>';
+ echo '</ul><br />';
+ echo 'Each method requires the following HTTP GET syntax:<br />';
+ echo '&nbsp;&nbsp; type=<i>methodname</i>&arg=<i>data</i> <br /><br />';
+ echo 'Where <i>methodname</i> is the name of an allowed method, and <i>data</i> is the argument to the call.<br />';
+ echo '<br />';
+ echo 'If you need jsonp type callback specification, you can provide an additional variable <i>callback</i>.<br />';
+ echo 'Example URL: <br />&nbsp;&nbsp; http://aur-url/rpc.php?type=search&arg=foobar&callback=jsonp1192244621103';
echo '</body></html>';
}
}