Template:ApiParam/en

{{ {{TNTN|Documentation}} |content=


 * Consider replacing invocations of this template with Special:ApiHelp transclusion (T89318), since filling in this template redundantly repeats API parameter documentation in source code.

Usage
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.

(or first unnamed) The parameter name (required). (or second unnamed) A description of the parameter. For values that have full descriptions of their own, as is often the case with  parameters, can be used to add extra *'s to the bullet. Specify a value if the parameter is required. The name of the required parameter will be bolded. For pipe-separated values or numeric quantities, the maximum allowed. As above, for bots. If 50 or 500 is used for, this will default to 500 or 5000, respectively. The data type of the parameter. A list of possible values for the parameter. The default value for the parameter. The version the parameter was introduced in. Use the plain MediaWiki version number only. The version the parameter was deprecated in. Use the plain MediaWiki version number only. The version the parameter was removed in. Use the plain MediaWiki version number only.

Examples


