diff options
| author | Lukas Fleischer <lfleischer@archlinux.org> | 2015-10-09 17:35:29 +0200 |
|---|---|---|
| committer | Lukas Fleischer <lfleischer@archlinux.org> | 2015-10-09 17:35:51 +0200 |
| commit | 1f6237ffa73f1cc931ec7cb2abbdd6ff54e1581a (patch) | |
| tree | 600826edd167b0ae4edd38f0c5316272658b5a9c /doc | |
| parent | 9d8345d4e09a16f0d4067638560e2e8318727d03 (diff) | |
| download | aur-1f6237ffa73f1cc931ec7cb2abbdd6ff54e1581a.tar.gz aur-1f6237ffa73f1cc931ec7cb2abbdd6ff54e1581a.tar.xz | |
aurjson: Rename the search_by parameter to "by"
This parameter is only supported by the search command. We do not need
to repeat ourselves.
Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rpc.txt | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/rpc.txt b/doc/rpc.txt index ee1fa1ec..f353ff01 100644 --- a/doc/rpc.txt +++ b/doc/rpc.txt @@ -5,11 +5,14 @@ Package Search -------------- 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`. ++/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`. If a maintainer search is performed and the search argument is left empty, a list of orphan packages is returned. |