Aide de l’API de MediaWiki
Ceci est une page d’aide de l’API de MediaWiki générée automatiquement.
Documentation et exemples : https://www.mediawiki.org/wiki/API
action=opensearch
(main | opensearch)
- Ce module nécessite des droits de lecture.
- Source : MediaWiki
- Licence : GPL-2.0+
Rechercher dans le wiki en utilisant le protocole OpenSearch.
Paramètres :
- search
Chaîne de recherche.
- Ce paramètre est obligatoire.
- namespace
Espaces de nom à rechercher.
- Valeurs (séparées par | ou autre) : 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 1198, 1199, 2300, 2301, 2302, 2303
- Par défaut : 0
- limit
Nombre maximal de résultats à renvoyer.
- Pas plus de 500 autorisé (5 000 pour les robots).
- Type : entier ou max
- Par défaut : 10
- suggest
Ne rien faire si $wgEnableOpenSearchSuggest vaut faux.
- Type : booléen (détails)
- redirects
Comment gérer les redirections :
- return
- Renvoie la redirection elle-même.
- resolve
- Renvoie la page cible. Peut renvoyer moins de limit résultats.
Pour des raisons historiques, la valeur par défaut est « return » pour format=json et « resolve » pour les autres formats.
- Une des valeurs suivantes : return, resolve
- format
Le format de sortie.
- Une des valeurs suivantes : json, jsonfm, xml, xmlfm
- Par défaut : json
- warningsaserror
Si des avertissements sont levés avec format=json, renvoyer une erreur d’API au lieu de les ignorer.
- Type : booléen (détails)
Exemple :
- Trouver les pages commençant par Te.
- api.php?action=opensearch&search=Te [ouvrir dans le bac à sable]