Difference between revisions of "Template:API-editnotice"
Jump to navigation
Jump to search
Template documentation
Joelmartin (talk | contribs) m (1 revision imported) |
Joelmartin (talk | contribs) m (Text replacement - "<tvar|(.*)>" to "") |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
| − | + | ||
| − | + | {{#switch: | |
| = | | = | ||
| − | + | ||
| − | + | ||
| − | ; | + | ; MW version |
| − | : | + | : Since which MediaWiki version is this api (sub)module available? ([[Release notes]]) |
| − | ; | + | ; API-head |
| − | : | + | : What's the prefix? Does this module require any rights or is it available to all anonymous users? Does it have to be POST'ed? |
| − | ; | + | ; Description |
| − | : | + | : Describe the module briefly in one or two sentences. |
| − | ; | + | ; Parameters: |
| − | ; | + | ; Error Codes: |
| − | ; | + | ; Example(s): |
| − | ; | + | ; Categories: |
| − | + | ||
| − | {{Note|1= | + | {{Note|1= You should consider using {{tl|Api help}} to transclude API documentation generated by Special:ApiHelp/''module-name'', instead of writing duplicate documentation for parameters, examples, etc. ([[phab:T89318]])}} |
| #default= | | #default= | ||
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:API-editnotice|noshift=1|uselang={{int:lang}}}} | {{#invoke:Template translation|renderTranslatedTemplate|template=Template:API-editnotice|noshift=1|uselang={{int:lang}}}} | ||
| − | + | ||
{{Documentation|content= | {{Documentation|content= | ||
| Line 26: | Line 26: | ||
}} | }} | ||
[[Category:API templates|{{PAGENAME}}]] | [[Category:API templates|{{PAGENAME}}]] | ||
| − | |||
Latest revision as of 15:54, 21 December 2019
{{#switch:
| =
- MW version
- Since which MediaWiki version is this api (sub)module available? (Release notes)
- API-head
- What's the prefix? Does this module require any rights or is it available to all anonymous users? Does it have to be POST'ed?
- Description
- Describe the module briefly in one or two sentences.
- Parameters
- Error Codes
- Example(s)
- Categories
You should consider using {{Api help}} to transclude API documentation generated by Special:ApiHelp/module-name, instead of writing duplicate documentation for parameters, examples, etc. (phab:T89318)
| #default=
Creating a new API documentation page
- MW version
- Since which MediaWiki version is this api (sub)module available? (Release notes)
- API-head
- What's the prefix? Does this module require any rights or is it available to all anonymous users? Does it have to be POST'ed?
- Description
- Describe the module briefly in one or two sentences.
- Parameters
- Error Codes
- Example(s)
- Categories
You should consider using {{Api help}} to transclude API documentation generated by Special:ApiHelp/module-name, instead of writing duplicate documentation for parameters, examples, etc. (phab:T89318)
Template documentationTemplate:API-addnew uses this to guide a wiki editor creating a new API page.