summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLukas Fleischer <lfleischer@archlinux.org>2015-10-04 09:27:28 +0200
committerLukas Fleischer <lfleischer@archlinux.org>2015-10-04 09:30:08 +0200
commitbc2ee0c63fcb18c0ab6494b167803a0b25a4a158 (patch)
treef0cefddea8a477758e9842de00fc7eb4ee18c0c7
parent6681e565512825193feafb8b9e6114e0bea595b9 (diff)
downloadaurweb-bc2ee0c63fcb18c0ab6494b167803a0b25a4a158.tar.xz
Add documentation of the RPC interface
Convert the RPC interface documentation from web/html/rpc.php to AsciiDoc and add it to the documentation directory. Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>
-rw-r--r--doc/rpc.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/rpc.txt b/doc/rpc.txt
new file mode 100644
index 0000000..b379515
--- /dev/null
+++ b/doc/rpc.txt
@@ -0,0 +1,33 @@
+aurweb RPC interface
+====================
+
+Allowed methods
+---------------
+
+* `search`
+* `info`
+* `multiinfo`
+* `msearch`
+
+Each method requires the following HTTP GET syntax:
++type=_methodname_&arg=_data_+
+
+Where _methodname_ is the name of an allowed method, and _data_ is the argument
+to the call.
+
+If you need jsonp type callback specification, you can provide an additional
+variable _callback_.
+
+Examples
+--------
+
+`search`::
+ `http://aur-url/rpc.php?type=search&arg=foobar`
+`info`::
+ `http://aur-url/rpc.php?type=info&arg=foobar`
+`multiinfo`::
+ `http://aur-url/rpc.php?type=multiinfo&arg[]=foo&arg[]=bar`
+`msearch`::
+ `http://aur-url/rpc.php?type=msearch&arg=john`
+Callback::
+ `http://aur-url/rpc.php?type=search&arg=foobar&callback=jsonp1192244621103`