EBernhardson has uploaded a new change for review.
https://gerrit.wikimedia.org/r/110967
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(+), 0 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Flow
refs/changes/67/110967/1
diff --git a/includes/api/ApiFlow.php b/includes/api/ApiFlow.php
index 03e0837..2e2c934 100644
--- a/includes/api/ApiFlow.php
+++ b/includes/api/ApiFlow.php
@@ -160,6 +160,11 @@
);
}
+ public function getDescription() {
+ return 'Shim to connect 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(
'action' => 'The action to take',
diff --git a/includes/api/ApiQueryFlow.php b/includes/api/ApiQueryFlow.php
index b606d19..1910814 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',
--
To view, visit https://gerrit.wikimedia.org/r/110967
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: If85109a1f9d26e08ef58155b2cfc21d9798f2f91
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Flow
Gerrit-Branch: master
Gerrit-Owner: EBernhardson <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
