Template:ApiParam

From MediaWiki.org
Jump to navigation Jump to search
Other languages:
English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎русский • ‎العربية • ‎فارسی • ‎中文 • ‎日本語
Template documentation
Consider replacing invocations of this template with Special:ApiHelp transclusion (phab:T89318), since filling in this template redundantly repeats API parameter documentation in source code.

Usage[edit]

This template can be used to document API parameters. Its intent is to harmonize the appearance of template parameters across all of the API pages.

{{ApiParam
|''name=''
|''description=''
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}
ApiParam parameters
Parameter Name Description
name (or first unnamed) The parameter name (required).
description (or second unnamed) A description of the parameter.
required Specify a value if the parameter is required. The name of the required parameter will be bolded.
maxallowed For pipe-separated values or numeric quantities, the maximum allowed.
maxallowedbot As above, for bots. If 50 or 500 is used for maxallowed, this will default to 500 or 5000, respectively.
type The data type of the parameter.
values A list of possible values for the parameter.
default The default value for the parameter.
version The version the parameter was introduced in. Use the plain MediaWiki version number only.
deprecated The version the parameter was deprecated in. Use the plain MediaWiki version number only.
removed The version the parameter was removed in. Use the plain MediaWiki version number only.

Examples[edit]

*{{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. No more than 50 (500 for bots) allowed.
*{{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 (Default: general)

See also[edit]