Aude has uploaded a new change for review. https://gerrit.wikimedia.org/r/262732
Change subject: Add links and examples for api modules ...................................................................... Add links and examples for api modules so one can click the link from the apihelp pages Change-Id: I34c2d675f4f8a1bc63ebac24fc4333c324d1a75d --- M i18n/en.json M i18n/qqq.json M includes/Api/ConfigDump.php M includes/Api/MappingDump.php M includes/Api/SettingsDump.php 5 files changed, 40 insertions(+), 1 deletion(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/CirrusSearch refs/changes/32/262732/2 diff --git a/i18n/en.json b/i18n/en.json index 7e6ba48..976aea7 100644 --- a/i18n/en.json +++ b/i18n/en.json @@ -17,8 +17,11 @@ "cirrussearch-pref-label": "New search", "cirrussearch-pref-desc": "Try our new search which supports a greater number of languages, provides more up-to-date results, and can even find text inside of templates.", "apihelp-cirrus-config-dump-description": "Dump of CirrusSearch configuration.", + "apihelp-cirrus-config-dump-example": "Get a dump of CirrusSearch configuration.", "apihelp-cirrus-mapping-dump-description": "Dump of CirrusSearch mapping for this wiki.", + "apihelp-cirrus-mapping-dump-example": "Get a dump of the CirrusSearch mapping for this wiki.", "apihelp-cirrus-settings-dump-description": "Dump of CirrusSearch settings for this wiki.", + "apihelp-cirrus-settings-dump-example": "Get a dump of CirrusSearch settings for this wiki.", "apihelp-cirrus-suggest-description": "Suggest completions for search term.", "apihelp-cirrus-suggest-param-text": "Search term to provide completions for.", "apihelp-cirrus-suggest-param-limit": "How many results to return.", diff --git a/i18n/qqq.json b/i18n/qqq.json index 738e85c..9892d27 100644 --- a/i18n/qqq.json +++ b/i18n/qqq.json @@ -25,8 +25,11 @@ "cirrussearch-pref-label": "Preference label for option to enable CirrusSearch by default", "cirrussearch-pref-desc": "Description for option to enable CirrusSearch by default", "apihelp-cirrus-config-dump-description": "{{doc-apihelp-description|cirrus-config-dump}}", + "apihelp-cirrus-config-dump-example": "{{doc-apihelp-example|cirrus-config-dump}}", "apihelp-cirrus-mapping-dump-description": "{{doc-apihelp-description|cirrus-mapping-dump}}", + "apihelp-cirrus-mapping-dump-example": "{{doc-apihelp-example|cirrus-mapping-dump}}", "apihelp-cirrus-settings-dump-description": "{{doc-apihelp-description|cirrus-settings-dump}}", + "apihelp-cirrus-settings-dump-example": "{{doc-apihelp-example|cirrus-settings-dump}}", "apihelp-cirrus-suggest-description": "{{doc-apihelp-description|cirrus-suggest}}", "apihelp-cirrus-suggest-param-text": "{{doc-apihelp-param|cirrus-suggest|text}}", "apihelp-cirrus-suggest-param-limit": "{{doc-apihelp-param|cirrus-suggest|limit}}", diff --git a/includes/Api/ConfigDump.php b/includes/Api/ConfigDump.php index cf99198..f741ad5 100644 --- a/includes/Api/ConfigDump.php +++ b/includes/Api/ConfigDump.php @@ -48,4 +48,15 @@ public function getDescription() { return 'Dump of CirrusSearch configuration.'; } + + /** + * @see ApiBase::getExamplesMessages + */ + protected function getExamplesMessages() { + return array( + 'action=cirrus-config-dump' => + 'apihelp-cirrus-config-dump-example' + ); + } + } diff --git a/includes/Api/MappingDump.php b/includes/Api/MappingDump.php index 4877f6c..3b38c32 100644 --- a/includes/Api/MappingDump.php +++ b/includes/Api/MappingDump.php @@ -40,4 +40,15 @@ public function getDescription() { return 'Dump of CirrusSearch mapping for this wiki.'; } + + /** + * @see ApiBase::getExamplesMessages + */ + protected function getExamplesMessages() { + return array( + 'action=cirrus-mapping-dump' => + 'apihelp-cirrus-mapping-dump-example' + ); + } + } diff --git a/includes/Api/SettingsDump.php b/includes/Api/SettingsDump.php index 856c07a..67f8357 100644 --- a/includes/Api/SettingsDump.php +++ b/includes/Api/SettingsDump.php @@ -37,6 +37,17 @@ * @deprecated since MediaWiki core 1.25 */ public function getDescription() { - return 'Dump of CirrusSearch mapping for this wiki.'; + return 'Dump of CirrusSearch settings for this wiki.'; } + + /** + * @see ApiBase::getExamplesMessages + */ + protected function getExamplesMessages() { + return array( + 'action=cirrus-settings-dump' => + 'apihelp-cirrus-settings-dump-example' + ); + } + } -- To view, visit https://gerrit.wikimedia.org/r/262732 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I34c2d675f4f8a1bc63ebac24fc4333c324d1a75d Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/extensions/CirrusSearch Gerrit-Branch: master Gerrit-Owner: Aude <aude.w...@gmail.com> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits