{
"@metadata": {
"authors": [
"Reedy",
"Chase me ladies, I'm the Cavalry"
]
},
"apihelp-main-description": "\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
\nStatus: 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\nErroneous requests: 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]].",
"apihelp-main-param-maxage": "Set the max-age header to this many seconds. Errors are never cached.",
"apihelp-main-param-assert": "Verify the user is logged in if set to user, or has the bot userright if bot.",
"apihelp-block-param-user": "Username, IP address, or IP range to block.",
"apihelp-block-param-allowusertalk": "Allow the user to edit their own talk page (depends on [[mw:Manual:$wgBlockAllowsUTEdit|$wgBlockAllowsUTEdit]]).",
"apihelp-block-param-watchuser": "Watch the user and talk pages of the user or IP address.",
"apihelp-block-example-ip-simple": "Block IP address 192.0.2.5 for three days with reason First strike.",
"apihelp-clearhasmsg-description": "Clears the hasmsg flag for the current user.",
"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.",
"apihelp-createaccount-param-password": "Password (ignored if $1mailpassword is set).",
"apihelp-delete-param-title": "Title of the page to delete. Cannot be used together with $1pageid.",
"apihelp-delete-param-watch": "Add the page to the current user's watchlist.",
"apihelp-delete-example-simple": "Delete Main Page.",
"apihelp-delete-example-reason": "Delete Main Page with the reason Preparing for move.",
"apihelp-edit-param-title": "Title of the page to edit. Cannot be used together with $1pageid.",
"apihelp-edit-param-watch": "Add the page to the current user's watchlist.",
"apihelp-edit-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
"apihelp-edit-param-contentformat": "Content serialisation format used for the input text.",
"apihelp-edit-example-prepend": "Prepend __NOTOC__ to a page.",
"apihelp-expandtemplates-example-simple": "Expand the wikitext {{Project:Sandbox}}.",
"apihelp-feedrecentchanges-param-hidemyself": "Hide changes made by the current user.",
"apihelp-filerevert-example-revert": "Revert Wiki.png to the version of 2011-03-05T15:27:40Z.",
"apihelp-help-example-main": "Help for the main module.",
"apihelp-help-example-query": "Help for two query submodules.",
"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 xml parameter.",
"apihelp-login-example-gettoken": "Retrieve a login token.",
"apihelp-logout-example-logout": "Log the current user out.",
"apihelp-move-param-to": "Title to rename the page to.",
"apihelp-move-param-reason": "Reason for the rename.",
"apihelp-move-example-move": "Move Badtitle to Goodtitle without leaving a redirect.",
"apihelp-opensearch-example-te": "Find pages beginning with Te.",
"apihelp-options-param-resetkinds": "List of types of options to reset when the $1reset option is set.",
"apihelp-options-param-optionvalue": "A value of the option specified by $1optionname, can contain pipe characters.",
"apihelp-options-example-change": "Change skin and hideminor preferences.",
"apihelp-options-example-complex": "Reset all preferences, then set skin and nickname.",
"apihelp-paraminfo-param-querymodules": "List of query module names (value of prop, meta or list parameter). Use $1modules=query+foo instead of $1querymodules=foo.",
"apihelp-parse-param-pageid": "Parse the content of this page. Overrides $1page.",
"apihelp-parse-param-contentformat": "Content serialisation format used for the input text. Only valid when used with $1text.",
"apihelp-patrol-example-rcid": "Patrol a recent change.",
"apihelp-patrol-example-revid": "Patrol a revision.",
"apihelp-protect-param-protections": "List of protection levels, formatted action=level (e.g. edit=sysop).\n\nNote: Any actions not listed will have restrictions removed.",
"apihelp-protect-param-expiry": "Expiry timestamps. If only one timestamp is set, it will be used for all protections. Use infinite, indefinite, infinity, or never, for a never-expiring protection.",
"apihelp-protect-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
"apihelp-protect-example-unprotect2": "Unprotect a page by setting no restrictions.",
"apihelp-purge-example-simple": "Purge the Main Page and the API page.",
"apihelp-query-example-allpages": "Fetch revisions of pages beginning with API/.",
"apihelp-query+allcategories-example-generator": "Retrieve information about the category page for categories beginning List.",
"apihelp-query+allfileusages-example-unique-generator": "Gets all file titles, marking the missing ones.",
"apihelp-query+alllinks-param-unique": "Only show distinct linked titles. Cannot be used with $1prop=ids.\nWhen used as a generator, yields target pages instead of source pages.",
"apihelp-query+alllinks-example-B": "List linked titles, including missing ones, with page IDs they are from, starting at B.",
"apihelp-query+alllinks-example-unique": "List unique linked titles.",
"apihelp-query+allmessages-example-ipb": "Show messages starting with ipb-.",
"apihelp-query+allmessages-example-de": "Show messages august and mainpage in German.",
"apihelp-query+allpages-example-B": "Show a list of pages starting at the letter B.",
"apihelp-query+allredirects-example-B": "List target pages, including missing ones, with page IDs they are from, starting at B.",
"apihelp-query+allredirects-example-generator": "Gets pages containing the redirects.",
"apihelp-query+alltransclusions-example-unique": "List unique transcluded titles.",
"apihelp-query+alltransclusions-example-generator": "Gets pages containing the transclusions.",
"apihelp-query+backlinks-param-pageid": "Page ID to search. Cannot be used together with $1title.",
"apihelp-query+backlinks-param-limit": "How many total pages to return. If $1redirect is enabled, limit applies to each level separately (which means up to 2 * $1limit results may be returned).",
"apihelp-query+backlinks-example-generator": "Get information about pages linking to Main page.",
"apihelp-query+blocks-param-ip": "Get all blocks applying to this IP or CIDR range, including range blocks.\nThis cannot be used together with $3users. CIDR ranges broader than IPv4/$1 or IPv6/$2 will not be not accepted.",
"apihelp-query+blocks-example-simple": "List blocks.",
"apihelp-query+blocks-example-users": "List blocks of users Alice and Bob.",
"apihelp-query+categoryinfo-example-simple": "Get information about Category:Foo and Category:Bar.",
"apihelp-query+categorymembers-param-pageid": "Page ID of the category to enumerate. Cannot be used together with $1title.",
"apihelp-query+categorymembers-param-endhexsortkey": "Sortkey to end listing from, as returned by $1prop=sortkey. Can only be used with $1sort=sortkey.",
"apihelp-query+deletedrevs-example-mode2": "List the last 50 deleted contributions by Bob (mode 2).",
"apihelp-query+deletedrevs-example-mode3-main": "List the first 50 deleted revisions in the main namespace (mode 3).",
"apihelp-query+deletedrevs-example-mode3-talk": "List the first 50 deleted pages in the {{ns:talk}} namespace (mode 3).",
"apihelp-query+duplicatefiles-example-simple": "Look for duplicates of [[:File:Albert Einstein Head.jpg]].",
"apihelp-query+duplicatefiles-example-generated": "Look for duplicates of all files.",
"apihelp-query+extlinks-example-simple": "Get a list of external links on Main Page.",
"apihelp-query+exturlusage-param-protocol": "Protocol of the URL. If empty and $1query set, the protocol is http. Leave both this and $1query empty to list all external links.",
"apihelp-query+filerepoinfo-example-simple": "Get information about file repositories.",
"apihelp-query+imageinfo-param-metadataversion": "Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.",
"apihelp-query+imageinfo-example-simple": "Fetch information about the current version of [[:File:Albert Einstein Head.jpg]].",
"apihelp-query+images-example-simple": "Get a list of files used in the [[Main Page]].",
"apihelp-query+imageusage-example-simple": "Show pages using [[:File:Albert Einstein Head.jpg]].",
"apihelp-query+imageusage-example-generator": "Get information about pages using [[:File:Albert Einstein Head.jpg]].",
"apihelp-query+info-example-protection": "Get general and protection information about the page Main Page.",
"apihelp-query+iwbacklinks-example-simple": "Get pages linking to [[wikibooks:Test]].",
"apihelp-query+iwlinks-param-title": "Interwiki link to search for. Must be used with $1prefix.",
"apihelp-query+langbacklinks-example-simple": "Get pages linking to [[:fr:Test]].",
"apihelp-query+langbacklinks-example-generator": "Get information about pages linking to [[:fr:Test]].",
"apihelp-query+langlinks-param-title": "Link to search for. Must be used with $1lang.",
"apihelp-query+links-example-simple": "Get links from the page Main Page",
"apihelp-query+links-example-namespaces": "Get links from the page Main Page in the {{ns:user}} and {{ns:template}} namespaces.",
"apihelp-query+linkshere-example-simple": "Get a list of pages linking to the [[Main Page]].",
"apihelp-query+linkshere-example-generator": "Get information about pages linking to the [[Main Page]].",
"apihelp-query+logevents-example-simple": "List recent log events.",
"apihelp-query+pagepropnames-description": "List all page property names in use on the wiki.",
"apihelp-query+pageswithprop-description": "List all pages using a given page property.",
"apihelp-query+pageswithprop-example-generator": "Get page information about the first 10 pages using __NOTOC__.",
"apihelp-query+protectedtitles-example-generator": "Find links to protected titles in the main namespace.",
"apihelp-query+random-example-simple": "Return two random pages from the main namespace.",
"apihelp-query+random-example-generator": "Return page info about two random pages from the main namespace.",
"apihelp-query+recentchanges-example-simple": "List recent changes.",
"apihelp-query+redirects-example-generator": "Get information about all redirects to the [[Main Page]].",
"apihelp-query+revisions-example-first5-not-localhost": "Get first 5 revisions of the Main Page that were not made by anonymous user 127.0.0.1.",
"apihelp-query+revisions+base-param-difftotext": "Text to diff each revision to. Only diffs a limited number of revisions. Overrides $1diffto. If $1section is set, only that section will be diffed against this text",
"apihelp-query+revisions+base-param-contentformat": "Serialisation format used for $1difftotext and expected for output of content.",
"apihelp-query+search-example-text": "Search texts for meaning.",
"apihelp-query+search-example-generator": "Get page information about the pages returned for a search for meaning.",
"apihelp-query+siteinfo-example-simple": "Fetch site information.",
"apihelp-query+siteinfo-example-replag": "Check the current replication lag.",
"apihelp-query+stashimageinfo-example-simple": "Returns information for a stashed file.",
"apihelp-query+tags-example-simple": "List available tags.",
"apihelp-query+templates-example-simple": "Get the templates used on the page Main Page.",
"apihelp-query+templates-example-generator": "Get information about the template pages used on Main Page.",
"apihelp-query+tokens-example-simple": "Retrieve a csrf token (the default).",
"apihelp-query+tokens-example-types": "Retrieve a watch token and a patrol token.",
"apihelp-query+transcludedin-example-simple": "Get a list of pages transcluding Main Page.",
"apihelp-query+transcludedin-example-generator": "Get information about pages transcluding Main Page.",
"apihelp-query+usercontribs-example-user": "Show contributions of user Example.",
"apihelp-query+userinfo-example-simple": "Get information about the current user.",
"apihelp-query+watchlist-example-simple": "List the top revision for recently changed pages on the watchlist of the current user.",
"apihelp-query+watchlist-example-generator": "Fetch page info for recently changed pages on the current user's watchlist.",
"apihelp-query+watchlistraw-description": "Get all pages on the current user's watchlist.",
"apihelp-query+watchlistraw-example-simple": "List pages on the watchlist of the current user.",
"apihelp-query+watchlistraw-example-generator": "Fetch page info for pages on the current user's watchlist.",
"apihelp-revisiondelete-example-revision": "Hide content for revision 12345 on the page Main Page.",
"apihelp-rollback-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
"apihelp-rollback-example-simple": "Roll back the last edits to page Main Page by user Example.",
"apihelp-setnotificationtimestamp-example-allpages": "Reset the notification status for pages in the {{ns:user}} namespace.",
"apihelp-unblock-param-id": "ID of the block to unblock (obtained through list=blocks). Cannot be used together with $1user.",
"apihelp-undelete-param-timestamps": "Timestamps of the revisions to restore. If both $1timestamps and $1fileids are empty, all will be restored.",
"apihelp-undelete-param-watchlist": "Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.",
"apihelp-undelete-example-page": "Undelete page Main Page.",
"apihelp-undelete-example-revisions": "Undelete two revisions of page Main Page.",
"apihelp-upload-param-comment": "Upload comment. Also used as the initial page text for new files if $1text is not specified.",
"apihelp-upload-example-url": "Upload from a URL.",
"apihelp-upload-example-filekey": "Complete an upload that failed due to warnings.",
"apihelp-userrights-example-userid": "Add the user with ID 123 to group bot, and remove from groups sysop and bureaucrat.",
"apihelp-watch-param-title": "The page to (un)watch. Use $1titles instead.",
"apihelp-watch-example-unwatch": "Unwatch the page Main Page.",
"apihelp-dbg-description": "Output data in PHP's var_export() format.",
"apihelp-dbgfm-description": "Output data in PHP's var_export() format (pretty-print in HTML).",
"apihelp-dump-description": "Output data in PHP's var_dump() format.",
"apihelp-php-description": "Output data in serialised PHP format.",
"apihelp-phpfm-description": "Output data in serialised PHP format (pretty-print in HTML).",
"apihelp-txt-description": "Output data in PHP's print_r() format.",
"apihelp-txtfm-description": "Output data in PHP's print_r() format (pretty-print in HTML).",
"api-pageset-param-redirects-generator": "Automatically resolve redirects in $1titles, $1pageids, and $1revids, and in pages returned by $1generator.",
"api-pageset-param-redirects-nogenerator": "Automatically resolve redirects in $1titles, $1pageids, and $1revids.",
"api-help-param-multi-separate": "Separate values with |.",
"api-help-param-disabled-in-miser-mode": "Disabled due to [[mw:Manual:$wgMiserMode|miser mode]].",
"api-help-param-limited-in-miser-mode": "Note: Due to [[mw:Manual:$wgMiserMode|miser mode]], using this may result in fewer than $1limit results returned before continuing; in extreme cases, zero results may be returned."
}