aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Rest/Module
diff options
context:
space:
mode:
authorbpirkle <bpirkle@wikimedia.org>2025-03-13 14:34:58 -0500
committerbpirkle <bpirkle@wikimedia.org>2025-03-21 11:54:50 -0500
commitbf5f59a1e9f94f4a7c612d657e0e455fde60dd3c (patch)
treee0c2493316a81d13a78d07f537d75cbe828eefc0 /includes/Rest/Module
parent8e343d805b16b893bde6ec6c61f4d5c519c0ba51 (diff)
downloadmediawikicore-bf5f59a1e9f94f4a7c612d657e0e455fde60dd3c.tar.gz
mediawikicore-bf5f59a1e9f94f4a7c612d657e0e455fde60dd3c.zip
REST: Make OpenAPI spec info strings translatable
OpenAPI specs include an "info" section that includes strings such as "title" and "description" that are intended to be human-readable. Make all such strings translatable. Bug: T385855 Change-Id: I15285be6d196c0e7fd7e922f23058d7c09b6b31a
Diffstat (limited to 'includes/Rest/Module')
-rw-r--r--includes/Rest/Module/ExtraRoutesModule.php6
-rw-r--r--includes/Rest/Module/SpecBasedModule.php4
2 files changed, 8 insertions, 2 deletions
diff --git a/includes/Rest/Module/ExtraRoutesModule.php b/includes/Rest/Module/ExtraRoutesModule.php
index 2b0e3ab7003f..49439c9dd232 100644
--- a/includes/Rest/Module/ExtraRoutesModule.php
+++ b/includes/Rest/Module/ExtraRoutesModule.php
@@ -8,6 +8,7 @@ use Iterator;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Rest\BasicAccess\BasicAuthorizerInterface;
use MediaWiki\Rest\Handler\RedirectHandler;
+use MediaWiki\Rest\JsonLocalizer;
use MediaWiki\Rest\PathTemplateMatcher\ModuleConfigurationException;
use MediaWiki\Rest\Reporter\ErrorReporter;
use MediaWiki\Rest\ResponseFactory;
@@ -246,9 +247,10 @@ class ExtraRoutesModule extends MatcherBasedModule {
public function getOpenApiInfo() {
// Note that mwapi-1.0 is based on OAS 3.0, so it doesn't support the
// "summary" property introduced in 3.1.
+ $localizer = new JsonLocalizer( $this->responseFactory );
return [
- 'title' => 'Extra Routes',
- 'description' => 'REST endpoints not associated with a module',
+ 'title' => $localizer->getFormattedMessage( 'rest-extra-routes-module-title' ),
+ 'description' => $localizer->getFormattedMessage( 'rest-extra-routes-module-desc' ),
'version' => 'undefined',
];
}
diff --git a/includes/Rest/Module/SpecBasedModule.php b/includes/Rest/Module/SpecBasedModule.php
index 0a074545962a..cce8dbddcc01 100644
--- a/includes/Rest/Module/SpecBasedModule.php
+++ b/includes/Rest/Module/SpecBasedModule.php
@@ -5,6 +5,7 @@ namespace MediaWiki\Rest\Module;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Rest\BasicAccess\BasicAuthorizerInterface;
use MediaWiki\Rest\Handler\RedirectHandler;
+use MediaWiki\Rest\JsonLocalizer;
use MediaWiki\Rest\PathTemplateMatcher\ModuleConfigurationException;
use MediaWiki\Rest\Reporter\ErrorReporter;
use MediaWiki\Rest\ResponseFactory;
@@ -121,6 +122,9 @@ class SpecBasedModule extends MatcherBasedModule {
);
}
+ $localizer = new JsonLocalizer( $this->responseFactory );
+ $moduleDef = $localizer->localizeJson( $moduleDef );
+
$this->moduleDef = $moduleDef;
return $this->moduleDef;
}