API: Document a level of 'all' in action=protect
authorBrad Jorsch <bjorsch@wikimedia.org>
Wed, 27 Jul 2016 13:29:07 +0000 (09:29 -0400)
committerBrad Jorsch <bjorsch@wikimedia.org>
Wed, 27 Jul 2016 13:33:20 +0000 (09:33 -0400)
It should be mentioned in the documentation for the 'protections'
parameter that 'all' exists to explicitly allow everyone to use the
action.

And the example using it seems to confuse some people into illogically
thinking that "action=all" means "restrict from all" rather than
"restrict to all" even though every other possible value means
"restrict to X", so reiterate it there too.

Bug: T141367
Change-Id: I2c3a2bf193c2ccb1ed28991ac785f7fee4948e6a

includes/api/i18n/en.json

index a8f0278..f7691ae 100644 (file)
        "apihelp-protect-description": "Change the protection level of a page.",
        "apihelp-protect-param-title": "Title of the page to (un)protect. Cannot be used together with $1pageid.",
        "apihelp-protect-param-pageid": "ID of the page to (un)protect. Cannot be used together with $1title.",
-       "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.",
+       "apihelp-protect-param-protections": "List of protection levels, formatted <kbd>action=level</kbd> (e.g. <kbd>edit=sysop</kbd>). A level of <kbd>all</kbd> means everyone is allowed to take the action, i.e. no restriction.\n\n<strong>Note:</strong> Any actions not listed will have restrictions removed.",
        "apihelp-protect-param-expiry": "Expiry timestamps. If only one timestamp is set, it'll be used for all protections. Use <kbd>infinite</kbd>, <kbd>indefinite</kbd>, <kbd>infinity</kbd>, or <kbd>never</kbd>, for a never-expiring protection.",
        "apihelp-protect-param-reason": "Reason for (un)protecting.",
        "apihelp-protect-param-tags": "Change tags to apply to the entry in the protection log.",
        "apihelp-protect-param-watch": "If set, add the page being (un)protected to the current user's watchlist.",
        "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-protect": "Protect a page.",
-       "apihelp-protect-example-unprotect": "Unprotect a page by setting restrictions to <kbd>all</kbd>.",
+       "apihelp-protect-example-unprotect": "Unprotect a page by setting restrictions to <kbd>all</kbd> (i.e. everyone is allowed to take the action).",
        "apihelp-protect-example-unprotect2": "Unprotect a page by setting no restrictions.",
 
        "apihelp-purge-description": "Purge the cache for the given titles.\n\nRequires a POST request if the user is not logged in.",