ItSpiderman has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/345830 )
Change subject: API Documentation
......................................................................
API Documentation
Change-Id: Ib1f018e545eadb883e4ce11b2a875b420b25e057
---
M includes/api/BSApiPingTasks.php
1 file changed, 45 insertions(+), 1 deletion(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/BlueSpiceFoundation
refs/changes/30/345830/1
diff --git a/includes/api/BSApiPingTasks.php b/includes/api/BSApiPingTasks.php
index aedeb05..24a66fe 100644
--- a/includes/api/BSApiPingTasks.php
+++ b/includes/api/BSApiPingTasks.php
@@ -31,7 +31,51 @@
* @package BlueSpice_Foundation
*/
class BSApiPingTasks extends BSApiTasksBase {
- protected $aTasks = array( 'ping' );
+ protected $aTasks = array(
+ 'ping' => [
+ 'examples' => [
+ [
+ 'iArticleID' => 543,
+ 'iNamespace' => 10,
+ 'sTitle' => 'Some page',
+ 'iRevision' => 324,
+ 'BsPingData' => [
+ [
+ 'sRef' => 'Reference',
+ 'aData' => []
+ ]
+ ]
+ ]
+ ],
+ 'params' => [
+ 'iArticleID' => [
+ 'desc' => '',
+ 'type' => 'integer',
+ 'required' => false
+ ],
+ 'iNamespace' => [
+ 'desc' => '',
+ 'type' => 'integer',
+ 'required' => false
+ ],
+ 'sTitle' => [
+ 'desc' => '',
+ 'type' => 'string',
+ 'required' => false
+ ],
+ 'iRevision' => [
+ 'desc' => '',
+ 'type' => 'integer',
+ 'required' => false
+ ],
+ 'BsPingData' => [
+ 'desc' => '',
+ 'type' => 'array',
+ 'required' => true
+ ],
+ ]
+ ]
+ );
protected $aReadTasks = array( 'ping' );
--
To view, visit https://gerrit.wikimedia.org/r/345830
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib1f018e545eadb883e4ce11b2a875b420b25e057
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/BlueSpiceFoundation
Gerrit-Branch: master
Gerrit-Owner: ItSpiderman <d.savulje...@gmail.com>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
