external/aurweb
0
0
Fork 0
mirror of https://gitlab.archlinux.org/archlinux/aurweb.git synced 2025-02-03 10:43:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: update rpc documentation

Browse source 
- we no longer prefer the use of trailing slashes on the AUR
  website.

Signed-off-by: Kevin Morris <kevr@0cost.org>
This commit is contained in:
Kevin Morris 2022-02-04 21:27:01 -08:00
parent 3cb106bc9d
commit 6986d1bb1e
No known key found for this signature in database
GPG key ID: F7E46DED420788F3
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/rpc.txt
View file

@ -5,7 +5,7 @@ Package Search
-------------- --------------
Package searches can be performed by issuing HTTP GET requests of the form Package searches can be performed by issuing HTTP GET requests of the form
+/rpc/?v=5&type=search&by=_field_&arg=_keywords_+ where _keywords_ is the +/rpc?v=5&type=search&by=_field_&arg=_keywords_+ where _keywords_ is the
search argument and _field_ is one of the following values: search argument and _field_ is one of the following values:
* `name` (search by package name only) * `name` (search by package name only)
@ -25,25 +25,25 @@ Package Details
--------------- ---------------
Package information can be obtained by issuing HTTP GET requests of the form 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_, ... +/rpc?v=5&type=info&arg[]=_pkg1_&arg[]=_pkg2_&...+ where _pkg1_, _pkg2_, ...
are the names of packages to retrieve package details for. are the names of packages to retrieve package details for.
Examples Examples
-------- --------
`search`:: `search`::
`/rpc/?v=5&type=search&arg=foobar` `/rpc?v=5&type=search&arg=foobar`
`search` by maintainer:: `search` by maintainer::
`/rpc/?v=5&type=search&by=maintainer&arg=john` `/rpc?v=5&type=search&by=maintainer&arg=john`
`search` packages that have _boost_ as `makedepends`:: `search` packages that have _boost_ as `makedepends`::
`/rpc/?v=5&type=search&by=makedepends&arg=boost` `/rpc?v=5&type=search&by=makedepends&arg=boost`
`search` with callback:: `search` with callback::
`/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103` `/rpc?v=5&type=search&arg=foobar&callback=jsonp1192244621103`
`search` with API Version 6 for packages containing `cookie` AND `milk`:: `search` with API Version 6 for packages containing `cookie` AND `milk`::
`/rpc/?v=6&type=search&arg=cookie%20milk` `/rpc?v=6&type=search&arg=cookie%20milk`
`search` with API Version 6 for packages containing `cookie milk`:: `search` with API Version 6 for packages containing `cookie milk`::
`/rpc/?v=6&type=search&arg="cookie milk"` `/rpc?v=6&type=search&arg="cookie milk"`
`info`:: `info`::
`/rpc/?v=5&type=info&arg[]=foobar` `/rpc?v=5&type=info&arg[]=foobar`
`info` with multiple packages:: `info` with multiple packages::
`/rpc/?v=5&type=info&arg[]=foo&arg[]=bar` `/rpc?v=5&type=info&arg[]=foo&arg[]=bar`