http://www.mediawiki.org/wiki/Special:Code/MediaWiki/89461
Revision: 89461
Author: reedy
Date: 2011-06-04 11:31:22 +0000 (Sat, 04 Jun 2011)
Log Message:
-----------
* (bug 29265) Mediawiki API documentation incomplete
Flesh out documentation for the maxlag parameter
Modified Paths:
--------------
trunk/phase3/includes/api/ApiMain.php
Modified: trunk/phase3/includes/api/ApiMain.php
===================================================================
--- trunk/phase3/includes/api/ApiMain.php 2011-06-04 11:01:33 UTC (rev
89460)
+++ trunk/phase3/includes/api/ApiMain.php 2011-06-04 11:31:22 UTC (rev
89461)
@@ -752,7 +752,14 @@
'format' => 'The format of the output',
'action' => 'What action you would like to perform. See
below for module help',
'version' => 'When showing help, include version for
each module',
- 'maxlag' => 'Maximum lag',
+ 'maxlag' => array(
+ '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 a replag error, a HTTP 503 error is
returned, with the message like',
+ '"Waiting for $host: $lag seconds lagged\n".',
+ 'See
http://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information',
+ ),
'smaxage' => 'Set the s-maxage header to this many
seconds. Errors are never cached',
'maxage' => 'Set the max-age header to this many
seconds. Errors are never cached',
'requestid' => 'Request ID to distinguish requests.
This will just be output back to you',
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
