doc/rpc.txt

   1 aurweb RPC Interface
   2 ====================
   3
   4 Package Search
   5 --------------
   6
   7 Package searches can be performed by issuing HTTP GET requests of the form
   8 +/rpc/?v=5&type=search&by=_field_&arg=_keywords_+ where _keywords_ is the
   9 search argument and _field_ is one of the following values:
  10
  11 * `name` (search by package name only)
  12 * `name-desc` (search by package name and description)
  13 * `maintainer` (search by package maintainer)
  14
  15 The _by_ parameter can be skipped and defaults to `name-desc`.
  16
  17 If a maintainer search is performed and the search argument is left empty, a
  18 list of orphan packages is returned.
  19
  20 Package Details
  21 ---------------
  22
  23 Package information can be obtained by issuing HTTP GET requests of the form
  24 +/rpc/?v=5&type=info&arg[]=_pkg1_&arg[]=_pkg2_&...+ where _pkg1_, _pkg2_, ...
  25 are the names of packages to retrieve package details for.
  26
  27 Examples
  28 --------
  29
  30 `search`::
  31   `/rpc/?v=5&type=search&arg=foobar`
  32 `search` by maintainer::
  33   `/rpc/?v=5&type=search&search_by=maintainer&arg=john`
  34 `search` with callback::
  35   `/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103`
  36 `info`::
  37   `/rpc/?v=5&type=info&arg[]=foobar`
  38 `info` with multiple packages::
  39   `/rpc/?v=5&type=info&arg[]=foo&arg[]=bar`