| blob | 929ec7e02fec9ed7b285def0c54e023f35d8d9b2 |
1 {
2 "@metadata": {
3 "authors": [
4 "Reedy",
5 "Chase me ladies, I'm the Cavalry"
6 ]
7 },
8 "apihelp-main-description": "<div class=\"hlist plainlinks api-main-links\">\n* [[mw:API:Main_page|Documentation]]\n* [[mw:API:FAQ|FAQ]]\n* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-api Mailing list]\n* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce API Announcements]\n* [https://phabricator.wikimedia.org/maniphest/query/GebfyV4uCaLd/#R Bugs & requests]\n</div>\n<strong>Status:</strong> All features shown on this page should be working, but the API is still in active development, and may change at any time. Subscribe to [https://lists.wikimedia.org/pipermail/mediawiki-api-announce/ the mediawiki-api-announce mailing list] for notice of updates.\n\n<strong>Erroneous requests:</strong> When erroneous requests are sent to the API, an HTTP header will be sent with the key \"MediaWiki-API-Error\" and then both the value of the header and the error code sent back will be set to the same value. For more information see [[mw:API:Errors_and_warnings|API: Errors and warnings]].",
9 "apihelp-main-param-maxage": "Set the <code>max-age</code> header to this many seconds. Errors are never cached.",
10 "apihelp-main-param-assert": "Verify the user is logged in if set to <kbd>user</kbd>, or has the bot userright if <kbd>bot</kbd>.",
11 "apihelp-block-param-user": "Username, IP address, or IP range to block.",
12 "apihelp-block-param-allowusertalk": "Allow the user to edit their own talk page (depends on <var>[[mw:Manual:$wgBlockAllowsUTEdit|$wgBlockAllowsUTEdit]]</var>).",
13 "apihelp-block-param-watchuser": "Watch the user and talk pages of the user or IP address.",
14 "apihelp-block-example-ip-simple": "Block IP address <kbd>192.0.2.5</kbd> for three days with reason <kbd>First strike</kbd>.",
15 "apihelp-clearhasmsg-description": "Clears the <code>hasmsg</code> flag for the current user.",
16 "apihelp-compare-description": "Get the difference between 2 pages.\n\nA revision number, a page title, or a page ID for both \"from\" and \"to\" must be passed.",
17 "apihelp-createaccount-param-password": "Password (ignored if <var>$1mailpassword</var> is set).",
18 "apihelp-delete-param-title": "Title of the page to delete. Cannot be used together with <var>$1pageid</var>.",
19 "apihelp-delete-param-watch": "Add the page to the current user's watchlist.",
20 "apihelp-delete-example-simple": "Delete <kbd>Main Page</kbd>.",
21 "apihelp-delete-example-reason": "Delete <kbd>Main Page</kbd> with the reason <kbd>Preparing for move</kbd>.",
22 "apihelp-edit-param-title": "Title of the page to edit. Cannot be used together with <var>$1pageid</var>.",
23 "apihelp-edit-param-watch": "Add the page to the current user's watchlist.",
24 "apihelp-edit-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
25 "apihelp-edit-param-contentformat": "Content serialisation format used for the input text.",
26 "apihelp-edit-example-prepend": "Prepend <kbd>__NOTOC__</kbd> to a page.",
27 "apihelp-expandtemplates-example-simple": "Expand the wikitext <kbd><nowiki>{{Project:Sandbox}}</nowiki></kbd>.",
28 "apihelp-feedrecentchanges-param-hidemyself": "Hide changes made by the current user.",
29 "apihelp-filerevert-example-revert": "Revert <kbd>Wiki.png</kbd> to the version of <kbd>2011-03-05T15:27:40Z</kbd>.",
30 "apihelp-help-example-main": "Help for the main module.",
31 "apihelp-help-example-query": "Help for two query submodules.",
32 "apihelp-import-description": "Import a page from another wiki, or an XML file.\n\nNote that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the <var>xml</var> parameter.",
33 "apihelp-login-example-gettoken": "Retrieve a login token.",
34 "apihelp-logout-example-logout": "Log the current user out.",
35 "apihelp-move-param-to": "Title to rename the page to.",
36 "apihelp-move-param-reason": "Reason for the rename.",
37 "apihelp-move-example-move": "Move <kbd>Badtitle</kbd> to <kbd>Goodtitle</kbd> without leaving a redirect.",
38 "apihelp-opensearch-example-te": "Find pages beginning with <kbd>Te</kbd>.",
39 "apihelp-options-param-resetkinds": "List of types of options to reset when the <var>$1reset</var> option is set.",
40 "apihelp-options-param-optionvalue": "A value of the option specified by <var>$1optionname</var>, can contain pipe characters.",
41 "apihelp-options-example-change": "Change <kbd>skin</kbd> and <kbd>hideminor</kbd> preferences.",
42 "apihelp-options-example-complex": "Reset all preferences, then set <kbd>skin</kbd> and <kbd>nickname</kbd>.",
43 "apihelp-paraminfo-param-querymodules": "List of query module names (value of <var>prop</var>, <var>meta</var> or <var>list</var> parameter). Use <kbd>$1modules=query+foo</kbd> instead of <kbd>$1querymodules=foo</kbd>.",
44 "apihelp-parse-param-pageid": "Parse the content of this page. Overrides <var>$1page</var>.",
45 "apihelp-parse-param-contentformat": "Content serialisation format used for the input text. Only valid when used with $1text.",
46 "apihelp-patrol-example-rcid": "Patrol a recent change.",
47 "apihelp-patrol-example-revid": "Patrol a revision.",
48 "apihelp-protect-param-protections": "List of protection levels, formatted <kbd>action=level</kbd> (e.g. <kbd>edit=sysop</kbd>).\n\n<strong>Note:</strong> Any actions not listed will have restrictions removed.",
49 "apihelp-protect-param-expiry": "Expiry timestamps. If only one timestamp is set, it will be used for all protections. Use <kbd>infinite</kbd>, <kbd>indefinite</kbd>, <kbd>infinity</kbd>, or <kbd>never</kbd>, for a never-expiring protection.",
50 "apihelp-protect-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
51 "apihelp-protect-example-unprotect2": "Unprotect a page by setting no restrictions.",
52 "apihelp-purge-example-simple": "Purge the <kbd>Main Page</kbd> and the <kbd>API</kbd> page.",
53 "apihelp-query-example-allpages": "Fetch revisions of pages beginning with <kbd>API/</kbd>.",
54 "apihelp-query+allcategories-example-generator": "Retrieve information about the category page for categories beginning <kbd>List</kbd>.",
55 "apihelp-query+allfileusages-example-unique-generator": "Gets all file titles, marking the missing ones.",
56 "apihelp-query+alllinks-param-unique": "Only show distinct linked titles. Cannot be used with <kbd>$1prop=ids</kbd>.\nWhen used as a generator, yields target pages instead of source pages.",
57 "apihelp-query+alllinks-example-B": "List linked titles, including missing ones, with page IDs they are from, starting at <kbd>B</kbd>.",
58 "apihelp-query+alllinks-example-unique": "List unique linked titles.",
59 "apihelp-query+allmessages-example-ipb": "Show messages starting with <kbd>ipb-</kbd>.",
60 "apihelp-query+allmessages-example-de": "Show messages <kbd>august</kbd> and <kbd>mainpage</kbd> in German.",
61 "apihelp-query+allpages-example-B": "Show a list of pages starting at the letter <kbd>B</kbd>.",
62 "apihelp-query+allredirects-example-B": "List target pages, including missing ones, with page IDs they are from, starting at <kbd>B</kbd>.",
63 "apihelp-query+allredirects-example-generator": "Gets pages containing the redirects.",
64 "apihelp-query+alltransclusions-example-unique": "List unique transcluded titles.",
65 "apihelp-query+alltransclusions-example-generator": "Gets pages containing the transclusions.",
66 "apihelp-query+backlinks-param-pageid": "Page ID to search. Cannot be used together with <var>$1title</var>.",
67 "apihelp-query+backlinks-param-limit": "How many total pages to return. If <var>$1redirect</var> is enabled, limit applies to each level separately (which means up to 2 * <var>$1limit</var> results may be returned).",
68 "apihelp-query+backlinks-example-generator": "Get information about pages linking to <kbd>Main page<kbd>.",
69 "apihelp-query+blocks-param-ip": "Get all blocks applying to this IP or CIDR range, including range blocks.\nThis cannot be used together with <var>$3users</var>. CIDR ranges broader than IPv4/$1 or IPv6/$2 will not be not accepted.",
70 "apihelp-query+blocks-example-simple": "List blocks.",
71 "apihelp-query+blocks-example-users": "List blocks of users <kbd>Alice</kbd> and <kbd>Bob</kbd>.",
72 "apihelp-query+categoryinfo-example-simple": "Get information about <kbd>Category:Foo</kbd> and <kbd>Category:Bar</kbd>.",
73 "apihelp-query+categorymembers-param-pageid": "Page ID of the category to enumerate. Cannot be used together with <var>$1title</var>.",
74 "apihelp-query+categorymembers-param-endhexsortkey": "Sortkey to end listing from, as returned by <kbd>$1prop=sortkey</kbd>. Can only be used with <kbd>$1sort=sortkey</kbd>.",
75 "apihelp-query+deletedrevs-example-mode2": "List the last 50 deleted contributions by <kbd>Bob</kbd> (mode 2).",
76 "apihelp-query+deletedrevs-example-mode3-main": "List the first 50 deleted revisions in the main namespace (mode 3).",
77 "apihelp-query+deletedrevs-example-mode3-talk": "List the first 50 deleted pages in the {{ns:talk}} namespace (mode 3).",
78 "apihelp-query+duplicatefiles-example-simple": "Look for duplicates of [[:File:Albert Einstein Head.jpg]].",
79 "apihelp-query+duplicatefiles-example-generated": "Look for duplicates of all files.",
80 "apihelp-query+extlinks-example-simple": "Get a list of external links on <kbd>Main Page<kbd>.",
81 "apihelp-query+exturlusage-param-protocol": "Protocol of the URL. If empty and <var>$1query</var> set, the protocol is <kbd>http</kbd>. Leave both this and <var>$1query</var> empty to list all external links.",
82 "apihelp-query+filerepoinfo-example-simple": "Get information about file repositories.",
83 "apihelp-query+imageinfo-param-metadataversion": "Version of metadata to use. If <kbd>latest</kbd> is specified, use latest version. Defaults to <kbd>1</kbd> for backwards compatibility.",
84 "apihelp-query+imageinfo-example-simple": "Fetch information about the current version of [[:File:Albert Einstein Head.jpg]].",
85 "apihelp-query+images-example-simple": "Get a list of files used in the [[Main Page]].",
86 "apihelp-query+imageusage-example-simple": "Show pages using [[:File:Albert Einstein Head.jpg]].",
87 "apihelp-query+imageusage-example-generator": "Get information about pages using [[:File:Albert Einstein Head.jpg]].",
88 "apihelp-query+info-example-protection": "Get general and protection information about the page <kbd>Main Page</kbd>.",
89 "apihelp-query+iwbacklinks-example-simple": "Get pages linking to [[wikibooks:Test]].",
90 "apihelp-query+iwlinks-param-title": "Interwiki link to search for. Must be used with <var>$1prefix</var>.",
91 "apihelp-query+langbacklinks-example-simple": "Get pages linking to [[:fr:Test]].",
92 "apihelp-query+langbacklinks-example-generator": "Get information about pages linking to [[:fr:Test]].",
93 "apihelp-query+langlinks-param-title": "Link to search for. Must be used with <var>$1lang</var>.",
94 "apihelp-query+links-example-simple": "Get links from the page <kbd>Main Page</kbd>",
95 "apihelp-query+links-example-namespaces": "Get links from the page <kbd>Main Page</kbd> in the {{ns:user}} and {{ns:template}} namespaces.",
96 "apihelp-query+linkshere-example-simple": "Get a list of pages linking to the [[Main Page]].",
97 "apihelp-query+linkshere-example-generator": "Get information about pages linking to the [[Main Page]].",
98 "apihelp-query+logevents-example-simple": "List recent log events.",
99 "apihelp-query+pagepropnames-description": "List all page property names in use on the wiki.",
100 "apihelp-query+pageswithprop-description": "List all pages using a given page property.",
101 "apihelp-query+pageswithprop-example-generator": "Get page information about the first 10 pages using <code>__NOTOC__</code>.",
102 "apihelp-query+protectedtitles-example-generator": "Find links to protected titles in the main namespace.",
103 "apihelp-query+random-example-simple": "Return two random pages from the main namespace.",
104 "apihelp-query+random-example-generator": "Return page info about two random pages from the main namespace.",
105 "apihelp-query+recentchanges-example-simple": "List recent changes.",
106 "apihelp-query+redirects-example-generator": "Get information about all redirects to the [[Main Page]].",
107 "apihelp-query+revisions-example-first5-not-localhost": "Get first 5 revisions of the <kbd>Main Page</kbd> that were not made by anonymous user <kbd>127.0.0.1</kbd>.",
108 "apihelp-query+revisions+base-param-difftotext": "Text to diff each revision to. Only diffs a limited number of revisions. Overrides <var>$1diffto</var>. If <var>$1section</var> is set, only that section will be diffed against this text",
109 "apihelp-query+revisions+base-param-contentformat": "Serialisation format used for <var>$1difftotext</var> and expected for output of content.",
110 "apihelp-query+search-example-text": "Search texts for <kbd>meaning</kbd>.",
111 "apihelp-query+search-example-generator": "Get page information about the pages returned for a search for <kbd>meaning</kbd>.",
112 "apihelp-query+siteinfo-example-simple": "Fetch site information.",
113 "apihelp-query+siteinfo-example-replag": "Check the current replication lag.",
114 "apihelp-query+stashimageinfo-example-simple": "Returns information for a stashed file.",
115 "apihelp-query+tags-example-simple": "List available tags.",
116 "apihelp-query+templates-example-simple": "Get the templates used on the page <kbd>Main Page</kbd>.",
117 "apihelp-query+templates-example-generator": "Get information about the template pages used on <kbd>Main Page</kbd>.",
118 "apihelp-query+tokens-example-simple": "Retrieve a csrf token (the default).",
119 "apihelp-query+tokens-example-types": "Retrieve a watch token and a patrol token.",
120 "apihelp-query+transcludedin-example-simple": "Get a list of pages transcluding <kbd>Main Page</kbd>.",
121 "apihelp-query+transcludedin-example-generator": "Get information about pages transcluding <kbd>Main Page</kbd>.",
122 "apihelp-query+usercontribs-example-user": "Show contributions of user <kbd>Example</kbd>.",
123 "apihelp-query+userinfo-example-simple": "Get information about the current user.",
124 "apihelp-query+watchlist-example-simple": "List the top revision for recently changed pages on the watchlist of the current user.",
125 "apihelp-query+watchlist-example-generator": "Fetch page info for recently changed pages on the current user's watchlist.",
126 "apihelp-query+watchlistraw-description": "Get all pages on the current user's watchlist.",
127 "apihelp-query+watchlistraw-example-simple": "List pages on the watchlist of the current user.",
128 "apihelp-query+watchlistraw-example-generator": "Fetch page info for pages on the current user's watchlist.",
129 "apihelp-revisiondelete-example-revision": "Hide content for revision <kbd>12345</kbd> on the page <kbd>Main Page</kbd>.",
130 "apihelp-rollback-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
131 "apihelp-rollback-example-simple": "Roll back the last edits to page <kbd>Main Page</kbd> by user <kbd>Example</kbd>.",
132 "apihelp-setnotificationtimestamp-example-allpages": "Reset the notification status for pages in the <kbd>{{ns:user}}</kbd> namespace.",
133 "apihelp-unblock-param-id": "ID of the block to unblock (obtained through <kbd>list=blocks</kbd>). Cannot be used together with <var>$1user</var>.",
134 "apihelp-undelete-param-timestamps": "Timestamps of the revisions to restore. If both <var>$1timestamps</var> and <var>$1fileids</var> are empty, all will be restored.",
135 "apihelp-undelete-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
136 "apihelp-undelete-example-page": "Undelete page <kbd>Main Page</kbd>.",
137 "apihelp-undelete-example-revisions": "Undelete two revisions of page <kbd>Main Page</kbd>.",
138 "apihelp-upload-param-comment": "Upload comment. Also used as the initial page text for new files if <var>$1text</var> is not specified.",
139 "apihelp-upload-example-url": "Upload from a URL.",
140 "apihelp-upload-example-filekey": "Complete an upload that failed due to warnings.",
141 "apihelp-userrights-example-userid": "Add the user with ID <kbd>123</kbd> to group <kbd>bot</kbd>, and remove from groups <kbd>sysop</kbd> and <kbd>bureaucrat</kbd>.",
142 "apihelp-watch-param-title": "The page to (un)watch. Use <var>$1titles</var> instead.",
143 "apihelp-watch-example-unwatch": "Unwatch the page <kbd>Main Page</kbd>.",
144 "apihelp-dbg-description": "Output data in PHP's <code>var_export()</code> format.",
145 "apihelp-dbgfm-description": "Output data in PHP's <code>var_export()</code> format (pretty-print in HTML).",
146 "apihelp-dump-description": "Output data in PHP's <code>var_dump()</code> format.",
147 "apihelp-php-description": "Output data in serialised PHP format.",
148 "apihelp-phpfm-description": "Output data in serialised PHP format (pretty-print in HTML).",
149 "apihelp-txt-description": "Output data in PHP's <code>print_r()</code> format.",
150 "apihelp-txtfm-description": "Output data in PHP's <code>print_r()</code> format (pretty-print in HTML).",
151 "api-pageset-param-redirects-generator": "Automatically resolve redirects in <var>$1titles</var>, <var>$1pageids</var>, and <var>$1revids</var>, and in pages returned by <var>$1generator</var>.",
152 "api-pageset-param-redirects-nogenerator": "Automatically resolve redirects in <var>$1titles</var>, <var>$1pageids</var>, and <var>$1revids</var>.",
153 "api-help-param-multi-separate": "Separate values with <kbd>|</kbd>.",
154 "api-help-param-disabled-in-miser-mode": "Disabled due to [[mw:Manual:$wgMiserMode|miser mode]].",
155 "api-help-param-limited-in-miser-mode": "<strong>Note:</strong> Due to [[mw:Manual:$wgMiserMode|miser mode]], using this may result in fewer than <var>$1limit</var> results returned before continuing; in extreme cases, zero results may be returned."
156 }