Axuda da API de MediaWiki
Esta é unha páxina de documentación da API de MediaWiki xerada automaticamente.
Documentación e exemplos: https://www.mediawiki.org/wiki/API
action=opensearch
(main | opensearch)
- Este módulo precisa permisos de lectura.
- Fonte: MediaWiki
- Licenza: GPL-2.0-or-later
Buscar no wiki mediante o protocolo OpenSearch.
Parámetros:
- search
Buscar texto.
- Este parâmetro é obrigatório.
- namespace
Espazo de nomes no que buscar.
- Valores (separados con | ou outros): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar tódolos valores use *.
- Valor por omissão: 0
- limit
Número máximo de resultados a visualizar.
- Tipo: enteiro ou max
- O valor tem de estar entre 1 e 500.
- Valor por omissão: 10
- suggest
- Obsoleto.
Non facer nada se $wgEnableOpenSearchSuggest é falso.
- Tipo: booliano (detalhes)
- redirects
Como xestionar as redireccións:
- return
- Devolve a mesma redirección.
- resolve
- Devolve a páxina á que apunta. Pode devolver menos de limit resultados.
Por razóns históricas, o valor por defecto para format=json é "return" e "resolve" para outros formatos.
- Un valor dos seguintes valores: resolve, return
- format
O formato de saída.
- Un valor dos seguintes valores: json, jsonfm, xml, xmlfm
- Valor por omissão: json
- warningsaserror
Se os avisos son recibidos con format=json, devolver un erro de API no canto de ignoralos.
- Tipo: booliano (detalhes)
Exemplo:
- Atopar páxinas que comezan por Te.
- api.php?action=opensearch&search=Te [abrir en zona de probas]