| blob | c871be0b4626df27c22af0c22b3b07b8c0d83302 |
1 {
2 "@metadata": {
3 "authors": [
4 "Anomie"
5 ]
6 },
8 "apihelp-main-description": "<div class=\"hlist plainlinks api-main-links\">\n* [https://www.mediawiki.org/wiki/API:Main_page Documentation]\n* [https://www.mediawiki.org/wiki/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://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts 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, a 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 https://www.mediawiki.org/wiki/API:Errors_and_warnings.",
9 "apihelp-main-param-action": "Which action to perform.",
10 "apihelp-main-param-format": "The format of the output.",
11 "apihelp-main-param-maxlag": "Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code \"maxlag\" is returned with a message like \"Waiting for $host: $lag seconds lagged\".<br />See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information.",
12 "apihelp-main-param-smaxage": "Set the s-maxage header to this many seconds. Errors are never cached.",
13 "apihelp-main-param-maxage": "Set the max-age header to this many seconds. Errors are never cached.",
14 "apihelp-main-param-assert": "Verify the user is logged in if set to \"user\", or has the bot userright if \"bot\".",
15 "apihelp-main-param-requestid": "Any value given here will be included in the response. May be used to distinguish requests.",
16 "apihelp-main-param-servedby": "Include the hostname that served the request in the results.",
17 "apihelp-main-param-curtimestamp": "Include the current timestamp in the result.",
18 "apihelp-main-param-origin": "When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the Origin: header exactly, so it has to be set to something like http://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin: header, a 403 response will be returned. If this parameter matches the Origin: header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.",
19 "apihelp-main-param-uselang": "Language to use for message translations. A list of codes may be fetched from [[Special:ApiHelp/query+siteinfo|action=query&meta=siteinfo&siprop=languages]], or specify \"user\" to use the current user's language preference.",
21 "apihelp-format-example-generic": "Format the query result in the $1 format",
22 "apihelp-dbg-description": "Output data in PHP's var_export() format.",
23 "apihelp-dbgfm-description": "Output data in PHP's var_export() format (pretty-print in HTML).",
24 "apihelp-dump-description": "Output data in PHP's var_dump() format.",
25 "apihelp-dumpfm-description": "Output data in PHP's var_dump() format (pretty-print in HTML).",
26 "apihelp-json-description": "Output data in JSON format.",
27 "apihelp-json-param-callback": "If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.",
28 "apihelp-json-param-utf8": "If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences.",
29 "apihelp-jsonfm-description": "Output data in JSON format (pretty-print in HTML).",
30 "apihelp-none-description": "Output nothing.",
31 "apihelp-php-description": "Output data in serialized PHP format.",
32 "apihelp-phpfm-description": "Output data in serialized PHP format (pretty-print in HTML).",
33 "apihelp-rawfm-description": "Output data with the debugging elements in JSON format (pretty-print in HTML).",
34 "apihelp-txt-description": "Output data in PHP's print_r() format.",
35 "apihelp-txtfm-description": "Output data in PHP's print_r() format (pretty-print in HTML).",
36 "apihelp-wddx-description": "Output data in WDDX format.",
37 "apihelp-wddxfm-description": "Output data in WDDX format (pretty-print in HTML).",
38 "apihelp-xml-description": "Output data in XML format.",
39 "apihelp-xml-param-xslt": "If specified, adds <xslt> as stylesheet. This should be a wiki page in the MediaWiki namespace whose page name ends with \".xsl\".",
40 "apihelp-xml-param-includexmlnamespace": "If specified, adds an XML namespace.",
41 "apihelp-xmlfm-description": "Output data in XML format (pretty-print in HTML).",
42 "apihelp-yaml-description": "Output data in YAML format.",
43 "apihelp-yamlfm-description": "Output data in YAML format (pretty-print in HTML).",
45 "apihelp-help-description": "Display help for the specified modules.",
46 "apihelp-help-param-modules": "Modules to display help for (values of the action= and format= parameters, or \"main\"). Can specify submodules with a \"+\".",
47 "apihelp-help-param-submodules": "Include help for submodules of the named module.",
48 "apihelp-help-param-recursivesubmodules": "Include help for submodules recursively.",
49 "apihelp-help-param-helpformat": "Format of the help output.",
50 "apihelp-help-param-wrap": "Wrap the output in a standard API response structure.",
51 "apihelp-help-param-toc": "Include a table of contents in the HTML output.",
52 "apihelp-help-example-main": "Help for the main module",
53 "apihelp-help-example-recursive": "All help in one page",
54 "apihelp-help-example-help": "Help for the help module itself",
55 "apihelp-help-example-query": "Help for two query submodules",
57 "api-format-title": "MediaWiki API result",
58 "api-format-prettyprint-header": "You are looking at the HTML representation of the $1 format. HTML is good for debugging, but is unsuitable for application use.\n\nSpecify the format parameter to change the output format. To see the non-HTML representation of the $1 format, set format=$2.\n\nSee the [https://www.mediawiki.org/wiki/API complete documentation], or [[Special:ApiHelp/main|API help]] for more information.",
60 "api-help-title": "MediaWiki API help",
61 "api-help-lead": "This is an auto-generated MediaWiki API documentation page.\n\nDocumentation and examples: https://www.mediawiki.org/wiki/API",
62 "api-help-main-header": "Main module",
63 "api-help-fallback-description": "$1",
64 "api-help-fallback-parameter": "$1",
65 "api-help-fallback-example": "$1",
66 "api-help-flags": "",
67 "api-help-flag-deprecated": "This module is deprecated.",
68 "api-help-flag-internal": "<strong>This module is internal or unstable.</strong> Its operation may change without notice.",
69 "api-help-flag-readrights": "This module requires read rights.",
70 "api-help-flag-writerights": "This module requires write rights.",
71 "api-help-flag-mustbeposted": "This module only accepts POST requests.",
72 "api-help-flag-generator": "This module can be used as a generator.",
73 "api-help-help-urls": "",
74 "api-help-parameters": "{{PLURAL:$1|Parameter|Parameters}}:",
75 "api-help-param-deprecated": "Deprecated.",
76 "api-help-param-required": "This parameter is required.",
77 "api-help-param-list": "{{PLURAL:$1|1=One value|2=Values (separate with \"{{!}}\")}}: $2",
78 "api-help-param-list-can-be-empty": "{{PLURAL:$1|0=Must be empty|Can be empty, or $2}}",
79 "api-help-param-limit": "No more than $1 allowed.",
80 "api-help-param-limit2": "No more than $1 ($2 for bots) allowed.",
81 "api-help-param-integer-min": "The {{PLURAL:$1|1=value|2=values}} must be no less than $2.",
82 "api-help-param-integer-max": "The {{PLURAL:$1|1=value|2=values}} must be no greater than $3.",
83 "api-help-param-integer-minmax": "The {{PLURAL:$1|1=value|2=values}} must be between $2 and $3.",
84 "api-help-param-upload": "Must be posted as a file upload using multipart/form-data.",
85 "api-help-param-multi-separate": "Separate values with \"|\".",
86 "api-help-param-multi-max": "Maximum number of values is {{PLURAL:$1|$1}} ({{PLURAL:$2|$2}} for bots).",
87 "api-help-param-default": "Default: $1",
88 "api-help-param-default-empty": "Default: <span class=\"apihelp-empty\">(empty)</span>",
89 "api-help-param-token": "A \"$1\" token retrieved from [[Special:ApiHelp/query+tokens|action=query&meta=tokens]]",
90 "api-help-param-no-description": "<span class=\"apihelp-empty\">(no description)</span>",
91 "api-help-examples": "{{PLURAL:$1|Example|Examples}}:",
92 "api-help-permissions": "{{PLURAL:$1|Permission|Permissions}}:",
93 "api-help-permissions-granted-to": "{{PLURAL:$1|Granted to}}: $2",
94 "api-help-right-apihighlimits": "Use higher limits in API queries (slow queries: $1; fast queries: $2). The limits for slow queries also apply to multivalue parameters.",
96 "api-credits-header": "Credits",
97 "api-credits": "API developers:\n* Roan Kattouw (lead developer Sep 2007–2009)\n* Victor Vasiliev\n* Bryan Tong Minh\n* Sam Reed\n* Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)\n* Brad Jorsch (lead developer 2013–present)\n\nPlease send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org\nor file a bug report at https://bugzilla.wikimedia.org/."
98 }