rpc.txt 1.18 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
14
15
+/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)

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

17
18
If a maintainer search is performed and the search argument is left empty, a
list of orphan packages is returned.
19

20
21
Package Details
---------------
22

23
24
25
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.
26
27
28
29
30

Examples
--------

`search`::
31
32
33
34
35
  `/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`
36
`info`::
37
38
39
  `/rpc/?v=5&type=info&arg[]=foobar`
`info` with multiple packages::
  `/rpc/?v=5&type=info&arg[]=foo&arg[]=bar`