From e35d473048a965096242eae4f89d4f45a84dbd65 Mon Sep 17 00:00:00 2001 From: Brad Jorsch Date: Fri, 9 Mar 2018 14:44:17 -0500 Subject: [PATCH] API: Update prefixsearch/opensearch docs The psnamespace parameter to action=query&list=prefixsearch is ignored if pssearch has a valid namespace prefix. This should be documented. Same for the similar parameters to action=opensearch. Bug: T189139 Change-Id: I4914e5c915e6f8e5c0d5116f034ca671fe45a3f8 --- includes/api/i18n/en.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/api/i18n/en.json b/includes/api/i18n/en.json index ba5f25fc16..756852650d 100644 --- a/includes/api/i18n/en.json +++ b/includes/api/i18n/en.json @@ -316,7 +316,7 @@ "apihelp-opensearch-summary": "Search the wiki using the OpenSearch protocol.", "apihelp-opensearch-param-search": "Search string.", "apihelp-opensearch-param-limit": "Maximum number of results to return.", - "apihelp-opensearch-param-namespace": "Namespaces to search.", + "apihelp-opensearch-param-namespace": "Namespaces to search. Ignored if $1search begins with a valid namespace prefix.", "apihelp-opensearch-param-suggest": "Do nothing if [[mw:Special:MyLanguage/Manual:$wgEnableOpenSearchSuggest|$wgEnableOpenSearchSuggest]] is false.", "apihelp-opensearch-param-redirects": "How to handle redirects:\n;return:Return the redirect itself.\n;resolve:Return the target page. May return fewer than $1limit results.\nFor historical reasons, the default is \"return\" for $1format=json and \"resolve\" for other formats.", "apihelp-opensearch-param-format": "The format of the output.", @@ -1015,7 +1015,7 @@ "apihelp-query+prefixsearch-summary": "Perform a prefix search for page titles.", "apihelp-query+prefixsearch-extended-description": "Despite the similarity in names, this module is not intended to be equivalent to [[Special:PrefixIndex]]; for that, see [[Special:ApiHelp/query+allpages|action=query&list=allpages]] with the apprefix parameter. The purpose of this module is similar to [[Special:ApiHelp/opensearch|action=opensearch]]: to take user input and provide the best-matching titles. Depending on the search engine backend, this might include typo correction, redirect avoidance, or other heuristics.", "apihelp-query+prefixsearch-param-search": "Search string.", - "apihelp-query+prefixsearch-param-namespace": "Namespaces to search.", + "apihelp-query+prefixsearch-param-namespace": "Namespaces to search. Ignored if $1search begins with a valid namespace prefix.", "apihelp-query+prefixsearch-param-limit": "Maximum number of results to return.", "apihelp-query+prefixsearch-param-offset": "Number of results to skip.", "apihelp-query+prefixsearch-example-simple": "Search for page titles beginning with meaning.", -- 2.20.1