From: Brad Jorsch Date: Thu, 20 Jun 2019 16:55:34 +0000 (-0400) Subject: API: Update api-help-datatypes for Timestamp library changes X-Git-Tag: 1.34.0-rc.0~1314^2 X-Git-Url: http://git.cyclocoop.org/?a=commitdiff_plain;h=3f96c82e8fe3feb0731b42c97a33eb9a9a4d3a1d;p=lhc%2Fweb%2Fwiklou.git API: Update api-help-datatypes for Timestamp library changes Instead of reproducing the documentation that's now at https://www.mediawiki.org/wiki/Timestamp, let's just link to it. Bug: T224730 Change-Id: I26c3bafc7cc9145b573c3ef84877633733be3cb1 --- diff --git a/includes/api/i18n/en.json b/includes/api/i18n/en.json index b0dd49a97e..9843af42e8 100644 --- a/includes/api/i18n/en.json +++ b/includes/api/i18n/en.json @@ -1631,7 +1631,7 @@ "api-help-param-templated-var-first": "{$1} in the parameter's name should be replaced with values of $2", "api-help-param-templated-var": "{$1} with values of $2", "api-help-datatypes-header": "Data types", - "api-help-datatypes": "Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as [[Special:ApiHelp/edit|edits]] with MD5 checks) to fail.\n\nSome parameter types in API requests need further explanation:\n;boolean\n:Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.\n;timestamp\n:Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.\n:* ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)\n:* ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)\n:* MediaWiki format, 20010115145600\n:* Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)\n:* EXIF format, 2001:01:15 14:56:00\n:*RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00\n:* RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00\n:* C ctime format, Mon Jan 15 14:56:00 2001\n:* Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)\n:* The string now\n;alternative multiple-value separator\n:Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator ''and'' prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.", + "api-help-datatypes": "Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as [[Special:ApiHelp/edit|edits]] with MD5 checks) to fail.\n\nSome parameter types in API requests need further explanation:\n;boolean\n:Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.\n;timestamp\n:Timestamps may be specified in several formats, see [[mw:Special:MyLanguage/Timestamp|the Timestamp library input formats documented on mediawiki.org]] for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.\n;alternative multiple-value separator\n:Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator ''and'' prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.", "api-help-templatedparams-header": "Templated parameters", "api-help-templatedparams": "Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.", "api-help-param-type-limit": "Type: integer or max",