Template:ApiParam/fr

Documentation du modèle

Envisagez le remplacement de l'appel de ce modèle par la transclusion de Special:ApiHelp (tâche T89318), puisque l'initialisation de ce modèle répète la documentation des paramètres de l'API dans le code source.

Utilisation

Ce modèle peut être utilisé pour documenter les paramètres de l'API. Son but est d'harmoniser la présentation des paramètres de modèles au travers toutes les pages d'API.

{{ApiParam
|name=
|description=
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}

Paramètres du modèle ApiParam
Nom du paramètre	Description
name (ou le premier non nommé)	Nom du paramètre (obligatoire).
description (ou second non nommé	Description du paramètre
required	Spécifiez une valeur si le paramètre est obligatoire. Le nom du paramètre sera en gras.
maxallowed	Maximum autorisé (pour les valeurs séparées par la barre verticale ou pour des quantités numériques)
maxallowedbot	Comme ci-dessus, pour les robots. Si 50 ou 500 est utilisé pour maxallowed, ceci vaudra respectivement 500 ou 5000 par défaut.
type	Le type de données pour le paramètre.
values	Une liste des valeurs possibles pour le paramètre.
default	Valeur par défaut pour le paramètre.
version	Version dans laquelle le paramètre a été introduit. Utilise uniquement le numéro de version brut de MediaWiki.
deprecated	Version dans laquelle le paramètre a été déclaré obsolète. Utiliser uniquement le numéro de version brut de MediaWiki.
removed	Version dans laquelle le paramètre a été supprimé. Utiliser uniquement le numéro de version brut de MediaWiki.

Exemples

*{{ApiParam|rcid|One or more recent changes IDs from which to add or remove the tag.|maxallowed=50}}

• rcid : One or more recent changes IDs from which to add or remove the tag. Pas plus de 50 valeurs autorisées (500 pour les robots).

*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}

• siprop : Which properties to get (Valeur par défaut: general)
  • general : General site information
    • articlepath : $wgArticlePath 1.15+

Voir aussi

• {{Parameter }} – ancienne version de ApiParam

Les éditeurs peuvent expérimenter dans le bac à sable (créer | mirroir) et dans la page de test (créer) de ce modèle.
Sous-pages de ce modèle.