Template:ApiParam/ru

This page is a translated version of the page Template:ApiParam and the translation is 20% complete.

Документация шаблона

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

Использование

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	Required?
`name` (or first unnamed)	The parameter name.	Обязательно
`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.	По желанию

Примеры

*{{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. Разрешено не более 50 (500 для ботов).

*{{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 (По умолчанию: general)
- general: General site information
  - articlepath: $wgArticlePath 1.15+

См. также

{{Parameter }} – более старые версии ApiParam