jenkins-bot has submitted this change and it was merged.
Change subject: Mark API as a shim which will be replaced
......................................................................
Mark API as a shim which will be replaced
Adjust the auto-generated API documentation to make it clear
to bot owners that the current API is temporary and should
not yet be developed against.
Change-Id: If85109a1f9d26e08ef58155b2cfc21d9798f2f91
---
M includes/api/ApiFlow.php
M includes/api/ApiQueryFlow.php
2 files changed, 11 insertions(+), 8 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/api/ApiFlow.php b/includes/api/ApiFlow.php
index 03e0837..5aa56d1 100644
--- a/includes/api/ApiFlow.php
+++ b/includes/api/ApiFlow.php
@@ -135,10 +135,6 @@
return $output;
}
- public function getDescription() {
- return 'Allows actions to be taken on Flow Workflows';
- }
-
public function getAllowedParams() {
return array(
'flowaction' => array(
@@ -160,6 +156,11 @@
);
}
+ public function getDescription() {
+ return 'Shim to perform actions against the internal Flow API.
This API is not suggested ' .
+ 'for external use and will soon be superseded by an
integrated mediawiki api.';
+ }
+
public function getParamDescription() {
return array(
'action' => 'The action to take',
diff --git a/includes/api/ApiQueryFlow.php b/includes/api/ApiQueryFlow.php
index b606d19..0656707 100644
--- a/includes/api/ApiQueryFlow.php
+++ b/includes/api/ApiQueryFlow.php
@@ -68,6 +68,12 @@
);
}
+ public function getDescription() {
+ return 'Shim to query to the internal Flow API. This API is
not suggested ' .
+ 'for external use and will soon be superseded by an
integrated mediawiki api.';
+ }
+
+
public function getParamDescription() {
return array(
'workflow' => 'Hex-encoded ID of the workflow to query',
@@ -75,10 +81,6 @@
'action' => 'The view-type action to take',
'params' => 'View parameters to pass to each block,
indexed by block name',
);
- }
-
- public function getDescription() {
- return 'Queries the Flow subsystem for data';
}
public function getExamples() {
--
To view, visit https://gerrit.wikimedia.org/r/110967
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: If85109a1f9d26e08ef58155b2cfc21d9798f2f91
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/Flow
Gerrit-Branch: master
Gerrit-Owner: EBernhardson <[email protected]>
Gerrit-Reviewer: Legoktm <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
