Extension:ShoutWiki API

MediaWiki extensions manual

File:OOjs UI icon advanced.svg ShoutWiki API Release status: beta
Implementation	API
Description	A collection of ShoutWiki-specific API modules
Author(s)	Jack Phoenix
Latest version	0.7.0
MediaWiki	>= 1.35.0
License	Creative Commons Zero v1.0 Universal
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate>
Example	ShoutWiki
Quarterly downloads
Public wikis using
Translate the ShoutWiki API extension if it is available at translatewiki.net

ShoutWiki API extension is a collection of ShoutWiki-specific API modules; it currently consists of only one module, "listwikis".

Installation

File:OOjs UI icon notice-destructive.svg <translate> Warning:</translate>

This extension won't work on a vanilla MediaWiki install since it depends on ShoutWiki-specific code bits.

• <translate> [[<tvar name=2>Special:ExtensionDistributor/ShoutWikiAPI</tvar>|Download]] and move the extracted <tvar name=name>ShoutWikiAPI</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ShoutWikiAPI
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'ShoutWikiAPI' );
  

• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Modules

listwikis

listwikis
The listwikis module allows to query the wiki_list database table (the one created and used by ShoutWiki's CreateWiki extension) for information about ShoutWiki's wikis. <translate> This module cannot be used as a [[<tvar|1>Special:MyLanguage/API:Query#Generators</>|generator]].</translate>
<translate> Prefix</translate>
<translate> Required rights</translate>	staff
<translate> Post only?</translate>	<translate> Yes</translate>
<translate> Generated help</translate>	<translate> Current</translate>

• api.php?action=query&list=listwikis — get a list of all wikis (in practise it gets the list in groups of 100 wikis per group)
• api.php?action=query&list=listwikis&swdeleted=1 — also show deleted wikis
• api.php?action=query&list=listwikis&swwid=177 — show only information about the wiki with the ID number 177
• api.php?action=query&list=listwikis&swfrom=100&swto=150 — show the wikis with IDs from 100 to 150
• api.php?action=query&list=listwikis&swfrom=10000&swto=15000&swlang=de — show the German (language code de) wikis that have an ID number between 10000 and 15000
• api.php?action=query&list=listwikis&swcountonly=1 — show only the amount of wikis and nothing else (equivalent to the SQL query SELECT COUNT(*) FROM wiki_list WHERE wl_deleted = 0;)
• api.php?action=query&list=listwikis&swdeleted=1&swcountonly=1 — show total amount of wikis, including deleted ones, and nothing else (equivalent to the SQL query SELECT COUNT(*) FROM wiki_list;)