Commit bc2ee0c6 authored by Lukas Fleischer's avatar Lukas Fleischer
Browse files

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's avatarLukas Fleischer <lfleischer@archlinux.org>
parent 6681e565
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`
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment