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

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

7
Package searches can be performed by issuing HTTP GET requests of the form
8
9
10
11
12
13
+/rpc/?v=5&type=search&by=_field_&arg=_keywords_+ where _keywords_ is the
search argument and _field_ is one of the following values:

* `name` (search by package name only)
* `name-desc` (search by package name and description)
* `maintainer` (search by package maintainer)
14
15
16
17
* `depends` (search for packages that depend on _keywords_)
* `makedepends` (search for packages that makedepend on _keywords_)
* `optdepends` (search for packages that optdepend on _keywords_)
* `checkdepends` (search for packages that checkdepend on _keywords_)
18
19

The _by_ parameter can be skipped and defaults to `name-desc`.
20

21
22
If a maintainer search is performed and the search argument is left empty, a
list of orphan packages is returned.
23

24
25
Package Details
---------------
26

27
28
29
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.
30
31
32
33
34

Examples
--------

`search`::
35
36
  `/rpc/?v=5&type=search&arg=foobar`
`search` by maintainer::
37
38
39
  `/rpc/?v=5&type=search&by=maintainer&arg=john`
`search` packages that have _boost_ as `makedepends`::
  `/rpc/?v=5&type=search&by=makedepends&arg=boost`
40
41
`search` with callback::
  `/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103`
42
43
44
45
`search` with API Version 6 for packages containing `cookie` AND `milk`::
  `/rpc/?v=6&type=search&arg=cookie%20milk`
`search` with API Version 6 for packages containing `cookie milk`::
  `/rpc/?v=6&type=search&arg="cookie milk"`
46
`info`::
47
48
49
  `/rpc/?v=5&type=info&arg[]=foobar`
`info` with multiple packages::
  `/rpc/?v=5&type=info&arg[]=foo&arg[]=bar`