mirror of
https://gitlab.archlinux.org/archlinux/aurweb.git
synced 2025-02-03 10:43:03 +01:00
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>
This commit is contained in:
parent
6681e56551
commit
bc2ee0c63f
1 changed files with 33 additions and 0 deletions
33
doc/rpc.txt
Normal file
33
doc/rpc.txt
Normal file
|
@ -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`
|
Loading…
Add table
Reference in a new issue