Correct documentation for "maxlag" API parameter

Replication lag above the number of seconds specified in the "maxlag"
parameter causes index.php to send HTTP status code 503, yet that is
not the case for the API. See bug 31156.

Change-Id: I3847629d3a34633d8e319a055a1e3252bd4ec638

diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index 91b8cc8..97f5ecd 100644 (file)
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -999,7 +999,7 @@ class ApiMain extends ApiBase {
                                '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',
+                               'In case of a replag error, error code "maxlag" is returned, with the message like',
                                '"Waiting for $host: $lag seconds lagged\n".',
                                'See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information',
                        ),