Aide de l’API 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/Special:MyLanguage/API:Main_page

action=streamconfigs

(main | streamconfigs)
  • Ce module nécessite des droits de lecture.
  • Source : EventStreamConfig
  • Licence : GPL-2.0-or-later

Expose la configuration du flux d’événements. Renvoie uniquement « format=json » avec « formatversion=2 ».

Paramètres :
D'autres paramètres généraux sont disponibles.
streams

Liste des flux pour lesquels obtenir la configuration

Valeurs séparées par | ou autre.
Le nombre maximal de valeurs est 250 (ou 500 pour les clients ayant droit aux limites plus élevées).
constraints

Filtrer les résultats pour les entrées de configuration de flux qui ont ces paramètres

Valeurs séparées par | ou autre.
Le nombre maximal de valeurs est 50 (ou 500 pour les clients ayant droit aux limites plus élevées).
all_settings
Obsolète.

Inclure tous les paramètres dans les résultats de configuration du flux. Obsolète depuis la version 1.41. Tous les paramètres sont inclus par défaut.

Type : booléen (détails)
Exemples :
Obtenir les configurations de flux pour une liste de flux
api.php?action=streamconfigs&streams=mediawiki.page-view|mediawiki.button-click [ouvrir dans le bac à sable]
Obtenir la configuration de flux pour les flux avec tous les paramètres
api.php?action=streamconfigs&streams=mediawiki.button-click [ouvrir dans le bac à sable]
Obtenir la configuration de flux pour les flux qui ont des paramètres correspondant à ces contraintes
api.php?action=streamconfigs&streams=mediawiki.button-click&constraints=event_service_name=eventgate-main [ouvrir dans le bac à sable]