[aur-dev] [PATCH 6/6] rpc.php: Display generated documentation

Sun Oct 4 09:41:49 UTC 2015

Instead of hardcoding the RPC interface documentation in rpc.php,
include the HTML code of the documentation page generated by AsciiDoc.

Signed-off-by: Lukas Fleischer <lfleischer at archlinux.org>
---
 web/html/rpc.php | 29 +----------------------------
 1 file changed, 1 insertion(+), 28 deletions(-)

diff --git a/web/html/rpc.php b/web/html/rpc.php
index 415dcb8..64c9562 100644
--- a/web/html/rpc.php
+++ b/web/html/rpc.php
@@ -12,33 +12,6 @@ if ( isset($_GET['type']) ) {
 	echo $rpc_o->handle($_GET);
 }
 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.
-?>
-<html><body>
-<h2>Allowed methods</h2>
-<ul>
-  <li><tt>search</tt></li>
-  <li><tt>info</tt></li>
-  <li><tt>multiinfo</tt></li>
-  <li><tt>msearch</tt></li>
-</ul>
-<p>Each method requires the following HTTP GET syntax:</p>
-<pre>type=<em>methodname</em>&arg=<em>data</em></pre>
-<p>Where <em>methodname</em> is the name of an allowed method, and <em>data</em> is the argument to the call.</p>
-<p>If you need jsonp type callback specification, you can provide an additional variable <em>callback</em>.</p>
-<h2>Examples</h2>
-<dl>
-  <dt><tt>search</tt></dt><dd><tt>http://aur-url/rpc.php?type=search&arg=foobar</tt></li></dd>
-  <dt><tt>info</tt></dt><dd><tt>http://aur-url/rpc.php?type=info&arg=foobar</tt></dd>
-  <dt><tt>multiinfo</tt></dt><dd><tt>http://aur-url/rpc.php?type=multiinfo&arg[]=foo&arg[]=bar</tt></dd>
-  <dt><tt>msearch</tt></dt><dd><tt>http://aur-url/rpc.php?type=msearch&arg=john</tt></li></dd>
-  <dt>Callback</dt><dd><tt>http://aur-url/rpc.php?type=search&arg=foobar&callback=jsonp1192244621103</tt></dd>
-</dl>
-</body></html>
-<?php
-// close if statement
+	echo file_get_contents('../../doc/rpc.html');
 }
 ?>
-- 
2.6.0
