rpc.txt 1.17 KB
Newer Older
1
aurweb RPC Interface
2
3
====================

4
5
Package Search
--------------
6

7
8
9
10
11
12
Package searches can be performed by issuing HTTP GET requests of the form
+/rpc/?v=5&type=search&search_by=_by_&arg=_keywords_+ where _by_ is either
`name` (search by package name only), `name-desc` (search by package name and
description) or `maintainer` (search by package maintainer) and _keywords_ is
the search argument. The _search_by_ parameter can be skipped and defaults to
`name-desc`.
13

14
15
If a maintainer search is performed and the search argument is left empty, a
list of orphan packages is returned.
16

17
18
Package Details
---------------
19

20
21
22
Package information can be obtained by issuing HTTP GET requests of the form
+/rpc/?v=5&type=info&arg[]=_pkg1_&arg[]=_pkg2_&...+ where _pkg1_, _pkg2_, ...
are the names of packages to retrieve package details for.
23
24
25
26
27

Examples
--------

`search`::
28
29
30
31
32
  `/rpc/?v=5&type=search&arg=foobar`
`search` by maintainer::
  `/rpc/?v=5&type=search&search_by=maintainer&arg=john`
`search` with callback::
  `/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103`
33
`info`::
34
35
36
  `/rpc/?v=5&type=info&arg[]=foobar`
`info` with multiple packages::
  `/rpc/?v=5&type=info&arg[]=foo&arg[]=bar`