Справка MediaWiki API

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

action=opensearch

(main | opensearch)
  • Этот модуль требует прав на чтение.
  • Источник: MediaWiki
  • Лицензия: GPL-2.0+

Search the wiki using the OpenSearch protocol.

Параметры:
search

Строка поиска.

Это обязательный параметр.
namespace

Пространства имён для поиска.

Значения (разделённые с помощью | или альтернативного варианта): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101, 104, 105, 110, 111, 112, 113, 120, 121, 122, 123, 202, 203, 208, 209, 274, 275, 306, 307, 828, 829
To specify all values, use *.
По умолчанию: 0
limit

Максимальное число возвращаемых результатов.

Разрешено не более чем 500 (5000 для ботов).
Тип: целое число или max
По умолчанию: 10
suggest

Do nothing if $wgEnableOpenSearchSuggest is false.

Тип: двоичный (details)
redirects

How to handle redirects:

return
Return the redirect itself.
resolve
Return the target page. May return fewer than limit results.

For historical reasons, the default is "return" for format=json and "resolve" for other formats.

Одно из следующих значений: return, resolve
format

Формат вывода.

Одно из следующих значений: json, jsonfm, xml, xmlfm
По умолчанию: json
warningsaserror

If warnings are raised with format=json, return an API error instead of ignoring them.

Тип: двоичный (details)
Пример:
Find pages beginning with Te.
api.php?action=opensearch&search=Te [open in sandbox]