aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Rest
diff options
context:
space:
mode:
Diffstat (limited to 'includes/Rest')
-rw-r--r--includes/Rest/Handler/CompareHandler.php2
-rw-r--r--includes/Rest/Handler/LanguageLinksHandler.php2
-rw-r--r--includes/Rest/Handler/MediaFileHandler.php2
-rw-r--r--includes/Rest/Handler/MediaLinksHandler.php2
-rw-r--r--includes/Rest/Handler/ModuleSpecHandler.php3
-rw-r--r--includes/Rest/Handler/OpenSearchDescriptionHandler.php2
-rw-r--r--includes/Rest/Handler/PageHistoryCountHandler.php9
-rw-r--r--includes/Rest/Handler/PageHistoryHandler.php5
-rw-r--r--includes/Rest/Handler/SearchHandler.php3
-rw-r--r--includes/Rest/Handler/TransformHandler.php30
-rw-r--r--includes/Rest/i18n/en.json24
-rw-r--r--includes/Rest/i18n/qqq.json46
12 files changed, 107 insertions, 23 deletions
diff --git a/includes/Rest/Handler/CompareHandler.php b/includes/Rest/Handler/CompareHandler.php
index b39d6bb263f2..8200537906a3 100644
--- a/includes/Rest/Handler/CompareHandler.php
+++ b/includes/Rest/Handler/CompareHandler.php
@@ -194,11 +194,13 @@ class CompareHandler extends Handler {
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_REQUIRED => true,
Handler::PARAM_SOURCE => 'path',
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-compare-from' ),
],
'to' => [
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_REQUIRED => true,
Handler::PARAM_SOURCE => 'path',
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-compare-to' ),
],
];
}
diff --git a/includes/Rest/Handler/LanguageLinksHandler.php b/includes/Rest/Handler/LanguageLinksHandler.php
index c213a2bf8ba4..e9465938d215 100644
--- a/includes/Rest/Handler/LanguageLinksHandler.php
+++ b/includes/Rest/Handler/LanguageLinksHandler.php
@@ -5,6 +5,7 @@ namespace MediaWiki\Rest\Handler;
use MediaWiki\Languages\LanguageNameUtils;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageLookup;
+use MediaWiki\Rest\Handler;
use MediaWiki\Rest\Handler\Helper\PageRedirectHelper;
use MediaWiki\Rest\Handler\Helper\PageRestHelperFactory;
use MediaWiki\Rest\LocalizedHttpException;
@@ -158,6 +159,7 @@ class LanguageLinksHandler extends SimpleHandler {
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-language-links-title' ),
],
];
}
diff --git a/includes/Rest/Handler/MediaFileHandler.php b/includes/Rest/Handler/MediaFileHandler.php
index 3a6b161c1d2e..3c4c0acfda01 100644
--- a/includes/Rest/Handler/MediaFileHandler.php
+++ b/includes/Rest/Handler/MediaFileHandler.php
@@ -6,6 +6,7 @@ use File;
use MediaFileTrait;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageLookup;
+use MediaWiki\Rest\Handler;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\SimpleHandler;
@@ -134,6 +135,7 @@ class MediaFileHandler extends SimpleHandler {
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-media-file-title' ),
],
];
}
diff --git a/includes/Rest/Handler/MediaLinksHandler.php b/includes/Rest/Handler/MediaLinksHandler.php
index 6e5a97fd1cb6..e789d4096639 100644
--- a/includes/Rest/Handler/MediaLinksHandler.php
+++ b/includes/Rest/Handler/MediaLinksHandler.php
@@ -5,6 +5,7 @@ namespace MediaWiki\Rest\Handler;
use MediaFileTrait;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageLookup;
+use MediaWiki\Rest\Handler;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\SimpleHandler;
@@ -150,6 +151,7 @@ class MediaLinksHandler extends SimpleHandler {
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-media-links-title' ),
],
];
}
diff --git a/includes/Rest/Handler/ModuleSpecHandler.php b/includes/Rest/Handler/ModuleSpecHandler.php
index 29743bea8375..a497631f47f4 100644
--- a/includes/Rest/Handler/ModuleSpecHandler.php
+++ b/includes/Rest/Handler/ModuleSpecHandler.php
@@ -5,6 +5,7 @@ namespace MediaWiki\Rest\Handler;
use MediaWiki\Config\Config;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
+use MediaWiki\Rest\Handler;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Module\Module;
use MediaWiki\Rest\RequestData;
@@ -167,11 +168,13 @@ class ModuleSpecHandler extends SimpleHandler {
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-module-spec-module' ),
],
'version' => [
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-module-spec-version' ),
],
];
}
diff --git a/includes/Rest/Handler/OpenSearchDescriptionHandler.php b/includes/Rest/Handler/OpenSearchDescriptionHandler.php
index 78c565bebbde..ed186846c771 100644
--- a/includes/Rest/Handler/OpenSearchDescriptionHandler.php
+++ b/includes/Rest/Handler/OpenSearchDescriptionHandler.php
@@ -32,6 +32,7 @@ use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Utils\UrlUtils;
use MediaWiki\Xml\Xml;
use Wikimedia\Http\HttpAcceptParser;
+use Wikimedia\Message\MessageValue;
/**
* Handler for generating an OpenSearch description document.
@@ -188,6 +189,7 @@ class OpenSearchDescriptionHandler extends Handler {
return [
'ctype' => [
self::PARAM_SOURCE => 'query',
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-opensearch-ctype' ),
]
];
}
diff --git a/includes/Rest/Handler/PageHistoryCountHandler.php b/includes/Rest/Handler/PageHistoryCountHandler.php
index f5d2fa9f2ea4..1062ecf71141 100644
--- a/includes/Rest/Handler/PageHistoryCountHandler.php
+++ b/includes/Rest/Handler/PageHistoryCountHandler.php
@@ -6,6 +6,7 @@ use ChangeTags;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageLookup;
use MediaWiki\Permissions\GroupPermissionsLookup;
+use MediaWiki\Rest\Handler;
use MediaWiki\Rest\Handler\Helper\PageRedirectHelper;
use MediaWiki\Rest\Handler\Helper\PageRestHelperFactory;
use MediaWiki\Rest\LocalizedHttpException;
@@ -701,6 +702,7 @@ class PageHistoryCountHandler extends SimpleHandler {
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-count-title' ),
],
'type' => [
self::PARAM_SOURCE => 'path',
@@ -709,16 +711,19 @@ class PageHistoryCountHandler extends SimpleHandler {
array_keys( self::DEPRECATED_COUNT_TYPES )
),
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-count-type' ),
],
'from' => [
self::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'integer',
- ParamValidator::PARAM_REQUIRED => false
+ ParamValidator::PARAM_REQUIRED => false,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-count-from' ),
],
'to' => [
self::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'integer',
- ParamValidator::PARAM_REQUIRED => false
+ ParamValidator::PARAM_REQUIRED => false,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-count-to' ),
]
];
}
diff --git a/includes/Rest/Handler/PageHistoryHandler.php b/includes/Rest/Handler/PageHistoryHandler.php
index cc311b61d478..60a01d5be1bb 100644
--- a/includes/Rest/Handler/PageHistoryHandler.php
+++ b/includes/Rest/Handler/PageHistoryHandler.php
@@ -6,6 +6,7 @@ use ChangeTags;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageLookup;
use MediaWiki\Permissions\GroupPermissionsLookup;
+use MediaWiki\Rest\Handler;
use MediaWiki\Rest\Handler\Helper\PageRedirectHelper;
use MediaWiki\Rest\Handler\Helper\PageRestHelperFactory;
use MediaWiki\Rest\LocalizedHttpException;
@@ -430,21 +431,25 @@ class PageHistoryHandler extends SimpleHandler {
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-title' ),
],
'older_than' => [
self::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_REQUIRED => false,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-older-than' ),
],
'newer_than' => [
self::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_REQUIRED => false,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-newer-than' ),
],
'filter' => [
self::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => self::ALLOWED_FILTER_TYPES,
ParamValidator::PARAM_REQUIRED => false,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-pagehistory-filter' ),
],
];
}
diff --git a/includes/Rest/Handler/SearchHandler.php b/includes/Rest/Handler/SearchHandler.php
index 4c427acf068e..30bd7d2f49c7 100644
--- a/includes/Rest/Handler/SearchHandler.php
+++ b/includes/Rest/Handler/SearchHandler.php
@@ -24,6 +24,7 @@ use SearchEngineFactory;
use SearchResult;
use SearchSuggestion;
use StatusValue;
+use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
@@ -403,6 +404,7 @@ class SearchHandler extends Handler {
self::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-search-q' ),
],
'limit' => [
self::PARAM_SOURCE => 'query',
@@ -411,6 +413,7 @@ class SearchHandler extends Handler {
ParamValidator::PARAM_DEFAULT => self::LIMIT,
IntegerDef::PARAM_MIN => 1,
IntegerDef::PARAM_MAX => self::MAX_LIMIT,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-search-limit' ),
],
];
}
diff --git a/includes/Rest/Handler/TransformHandler.php b/includes/Rest/Handler/TransformHandler.php
index da96e291ecde..eb46243504ba 100644
--- a/includes/Rest/Handler/TransformHandler.php
+++ b/includes/Rest/Handler/TransformHandler.php
@@ -20,6 +20,7 @@
namespace MediaWiki\Rest\Handler;
+use MediaWiki\Rest\Handler;
use MediaWiki\Rest\Handler\Helper\ParsoidFormatHelper;
use MediaWiki\Rest\HttpException;
use MediaWiki\Rest\LocalizedHttpException;
@@ -40,18 +41,31 @@ class TransformHandler extends ParsoidHandler {
/** @inheritDoc */
public function getParamSettings() {
return [
- 'from' => [ self::PARAM_SOURCE => 'path',
+ 'from' => [
+ self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
- ParamValidator::PARAM_REQUIRED => true, ],
- 'format' => [ self::PARAM_SOURCE => 'path',
+ ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-transform-from' ),
+ ],
+ 'format' => [
+ self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
- ParamValidator::PARAM_REQUIRED => true, ],
- 'title' => [ self::PARAM_SOURCE => 'path',
+ ParamValidator::PARAM_REQUIRED => true,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-transform-format' ),
+ ],
+ 'title' => [
+ self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
- ParamValidator::PARAM_REQUIRED => false, ],
- 'revision' => [ self::PARAM_SOURCE => 'path',
+ ParamValidator::PARAM_REQUIRED => false,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-transform-title' ),
+ ],
+ 'revision' => [
+ self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
- ParamValidator::PARAM_REQUIRED => false, ], ];
+ ParamValidator::PARAM_REQUIRED => false,
+ Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-transform-revision' ),
+ ],
+ ];
}
/**
diff --git a/includes/Rest/i18n/en.json b/includes/Rest/i18n/en.json
index c38bfba62814..3f5191971e56 100644
--- a/includes/Rest/i18n/en.json
+++ b/includes/Rest/i18n/en.json
@@ -97,5 +97,27 @@
"rest-param-desc-html-output-flavor": "HTML output renderer flavor",
"rest-param-desc-page-content-title": "Page content title",
"rest-param-desc-page-content-redirect": "Page content redirect",
- "rest-param-desc-update-source": "Page content in the format specified by the content_model property"
+ "rest-param-desc-update-source": "Page content in the format specified by the content_model property",
+ "rest-param-desc-compare-from": "Compare from",
+ "rest-param-desc-compare-to": "Compare to",
+ "rest-param-desc-language-links-title": "Language links title",
+ "rest-param-desc-media-file-title": "Media file title",
+ "rest-param-desc-media-links-title": "Media links title",
+ "rest-param-desc-module-spec-module": "Module spec module",
+ "rest-param-desc-module-spec-version": "Module spec version",
+ "rest-param-desc-opensearch-ctype": "Open search description ctype",
+ "rest-param-desc-pagehistory-count-title": "Page history count title",
+ "rest-param-desc-pagehistory-count-type": "Page history count type",
+ "rest-param-desc-pagehistory-count-from": "Page history count from",
+ "rest-param-desc-pagehistory-count-to": "Page history count to",
+ "rest-param-desc-pagehistory-title": "Page history tite",
+ "rest-param-desc-pagehistory-older-than": "Page history older than",
+ "rest-param-desc-pagehistory-newer-than": "Page history newer than",
+ "rest-param-desc-pagehistory-filter": "Page history filter",
+ "rest-param-desc-search-q": "Search phrase being searched",
+ "rest-param-desc-search-limit": "The number of items to be returned",
+ "rest-param-desc-transform-from": "Transform from",
+ "rest-param-desc-transform-format": "Transform format",
+ "rest-param-desc-transform-title": "Transform title",
+ "rest-param-desc-transform-revision": "Transform revision"
}
diff --git a/includes/Rest/i18n/qqq.json b/includes/Rest/i18n/qqq.json
index 4733c1f186fc..d7d6149097b2 100644
--- a/includes/Rest/i18n/qqq.json
+++ b/includes/Rest/i18n/qqq.json
@@ -90,16 +90,38 @@
"rest-unsupported-language-conversion": "Error message for REST API debugging, shown when the language conversion is not supported. Parameters:\n* $1: The source format \n* $2: The target format",
"rest-unknown-content-model": "Error message for REST API debugging, shown when an unregistered content model is requested. Parameters:\n* $1: The name of the unknown content model",
"rest-page-bundle-validation-error": "Error message for REST API debugging, shown when PageBundle does not match the given contentVersion. Parameters:\n* $1: The error details",
- "rest-param-desc-revision-id": "{{notranslate}} Revision id parameter description",
- "rest-param-desc-html-input-title": "{{notranslate}} HTML input transform title parameter description",
- "rest-param-desc-html-input-oldid": "{{notranslate}} HTML input transform oldid parameter description",
- "rest-param-desc-html-input-from": "{{notranslate}} HTML input transform from parameter description",
- "rest-param-desc-html-input-format": "{{notranslate}} HTML input transform format parameter description",
- "rest-param-desc-html-input-contentmodel": "{{notranslate}} HTML input transform contentmodel parameter description",
- "rest-param-desc-html-input-language": "{{notranslate}} HTML input transform language parameter description",
- "rest-param-desc-html-output-stash": "{{notranslate}} HTML output renderer stash parameter description",
- "rest-param-desc-html-output-flavor": "{{notranslate}} HTML output renderer flavor parameter description",
- "rest-param-desc-page-content-title": "{{notranslate}} Page content title parameter description",
- "rest-param-desc-page-content-redirect": "{{notranslate}} Page content redirect parameter description",
- "rest-param-desc-update-source": "Request body parameter providing the page content"
+ "rest-param-desc-revision-id": "{{Experimental}} Revision id parameter description",
+ "rest-param-desc-html-input-title": "{{Experimental}} HTML input transform title parameter description",
+ "rest-param-desc-html-input-oldid": "{{Experimental}} HTML input transform oldid parameter description",
+ "rest-param-desc-html-input-from": "{{Experimental}} HTML input transform from parameter description",
+ "rest-param-desc-html-input-format": "{{Experimental}} HTML input transform format parameter description",
+ "rest-param-desc-html-input-contentmodel": "{{Experimental}} HTML input transform contentmodel parameter description",
+ "rest-param-desc-html-input-language": "{{Experimental}} HTML input transform language parameter description",
+ "rest-param-desc-html-output-stash": "{{Experimental}} HTML output renderer stash parameter description",
+ "rest-param-desc-html-output-flavor": "{{Experimental}} HTML output renderer flavor parameter description",
+ "rest-param-desc-page-content-title": "{{Experimental}} Page content title parameter description",
+ "rest-param-desc-page-content-redirect": "{{Experimental}} Page content redirect parameter description",
+ "rest-param-desc-update-source": "{{Experimental}} Request body parameter providing the page content",
+ "rest-param-desc-compare-from": "{{Experimental}} Compare from parameter description",
+ "rest-param-desc-compare-to": "{{Experimental}} Compare to parameter description",
+ "rest-param-desc-language-links-title": "{{Experimental}} Language links title parameter description",
+ "rest-param-desc-media-file-title": "{{Experimental}} Media file title parameter description",
+ "rest-param-desc-media-links-title": "{{Experimental}} Media links title parameter description",
+ "rest-param-desc-module-spec-module": "{{Experimental}} Module spec module parameter description",
+ "rest-param-desc-module-spec-version": "{{Experimental}} Module spec version parameter description",
+ "rest-param-desc-opensearch-ctype": "{{Experimental}} Open search description ctype parameter description",
+ "rest-param-desc-pagehistory-count-title": "{{Experimental}} Page history count title parameter description",
+ "rest-param-desc-pagehistory-count-type": "{{Experimental}} Page history count type parameter description",
+ "rest-param-desc-pagehistory-count-from": "{{Experimental}} Page history count from parameter description",
+ "rest-param-desc-pagehistory-count-to": "{{Experimental}} Page history count to parameter description",
+ "rest-param-desc-pagehistory-title": "{{Experimental}} Page history tite parameter description",
+ "rest-param-desc-pagehistory-older-than": "{{Experimental}} Page history older than parameter description",
+ "rest-param-desc-pagehistory-newer-than": "{{Experimental}} Page history newer than parameter description",
+ "rest-param-desc-pagehistory-filter": "{{Experimental}} Page history filter parameter description",
+ "rest-param-desc-search-q": "{{Experimental}} Search phrase being searched",
+ "rest-param-desc-search-limit": "{{Experimental}} The number of items to be returned",
+ "rest-param-desc-transform-from": "{{Experimental}} Transform from parameter description",
+ "rest-param-desc-transform-format": "{{Experimental}} Transform format parameter description",
+ "rest-param-desc-transform-title": "{{Experimental}} Transform title parameter description",
+ "rest-param-desc-transform-revision": "{{Experimental}} Transform revision parameter description"
}
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-26 20:01:19 +0000