From 1f6237ffa73f1cc931ec7cb2abbdd6ff54e1581a Mon Sep 17 00:00:00 2001 From: Lukas Fleischer Date: Fri, 9 Oct 2015 17:35:29 +0200 Subject: 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 --- doc/rpc.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/rpc.txt b/doc/rpc.txt index ee1fa1e..f353ff0 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. -- cgit v1.2.3-70-g09d2