API: Some raw message cleanup
authorBrad Jorsch <bjorsch@wikimedia.org>
Tue, 28 Jun 2016 15:16:38 +0000 (11:16 -0400)
committerBrad Jorsch <bjorsch@wikimedia.org>
Wed, 24 Aug 2016 17:19:52 +0000 (13:19 -0400)
* Set an indexed tag name in ApiParamInfo and ApiAuthManagerHelper.
* Use 'key' instead of 'message' for the (not yet used) non-BC
  ApiErrorFormatter.

Change-Id: I07f0a690e263b34e09210673241af8bf750cbd1b

includes/api/ApiAuthManagerHelper.php
includes/api/ApiErrorFormatter.php
includes/api/ApiParamInfo.php
tests/phpunit/includes/api/ApiErrorFormatterTest.php

index a4f54ee..8e57f93 100644 (file)
@@ -85,6 +85,7 @@ class ApiAuthManagerHelper {
                                        'key' => $message->getKey(),
                                        'params' => $message->getParams(),
                                ];
+                               ApiResult::setIndexedTagName( $res[$key]['params'], 'param' );
                                break;
                }
        }
index c19926a..6d9184f 100644 (file)
@@ -202,7 +202,7 @@ class ApiErrorFormatter {
 
                        case 'raw':
                                $value += [
-                                       'message' => $msg->getKey(),
+                                       'key' => $msg->getKey(),
                                        'params' => $msg->getParams(),
                                ];
                                ApiResult::setIndexedTagName( $value['params'], 'param' );
index c3c9e21..25e1a7f 100644 (file)
@@ -162,6 +162,7 @@ class ApiParamInfo extends ApiBase {
                                                'key' => $m->getKey(),
                                                'params' => $m->getParams(),
                                        ];
+                                       ApiResult::setIndexedTagName( $a['params'], 'param' );
                                        if ( $m instanceof ApiHelpParamValueMessage ) {
                                                $a['forvalue'] = $m->getParamValue();
                                        }
index 18da5af..d13b00b 100644 (file)
@@ -132,7 +132,7 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'err' => [
                                                        [
                                                                'code' => 'mainpage',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ]
                                                        ],
                                                        $I => 'error',
@@ -142,7 +142,7 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'string' => [
                                                        [
                                                                'code' => 'mainpage',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ]
                                                        ],
                                                        $I => 'warning',
@@ -154,7 +154,7 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'errWithData' => [
                                                        [
                                                                'code' => 'overriddenCode',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ],
                                                                'overriddenData' => true
                                                        ],
@@ -165,7 +165,7 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'messageWithData' => [
                                                        [
                                                                'code' => 'overriddenCode',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ],
                                                                'overriddenData' => true
                                                        ],
@@ -174,7 +174,7 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'message' => [
                                                        [
                                                                'code' => 'mainpage',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ]
                                                        ],
                                                        $I => 'warning',
@@ -182,12 +182,12 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'foo' => [
                                                        [
                                                                'code' => 'mainpage',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ]
                                                        ],
                                                        [
                                                                'code' => 'parentheses',
-                                                               'message' => 'parentheses',
+                                                               'key' => 'parentheses',
                                                                'params' => [ 'foobar', $I => 'param' ]
                                                        ],
                                                        $I => 'warning',
@@ -199,12 +199,12 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'status' => [
                                                        [
                                                                'code' => 'mainpage',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ]
                                                        ],
                                                        [
                                                                'code' => 'parentheses',
-                                                               'message' => 'parentheses',
+                                                               'key' => 'parentheses',
                                                                'params' => [ 'foobar', $I => 'param' ]
                                                        ],
                                                        $I => 'error',
@@ -214,17 +214,17 @@ class ApiErrorFormatterTest extends MediaWikiLangTestCase {
                                                'status' => [
                                                        [
                                                                'code' => 'mainpage',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ]
                                                        ],
                                                        [
                                                                'code' => 'parentheses',
-                                                               'message' => 'parentheses',
+                                                               'key' => 'parentheses',
                                                                'params' => [ 'foobar', $I => 'param' ]
                                                        ],
                                                        [
                                                                'code' => 'overriddenCode',
-                                                               'message' => 'mainpage',
+                                                               'key' => 'mainpage',
                                                                'params' => [ $I => 'param' ],
                                                                'overriddenData' => true
                                                        ],