Extension:WikibaseManifest

MediaWiki extensions manual
WikibaseManifest
Release status: beta
Implementation API
Description API provided metadata for structured data repository
Author(s) The Wikidata team
Latest version 0.0.1 (continuous updates)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki master
Database changes No
License GNU General Public License 2.0 or later
Download
readme

  • $wgWbManifestWikidataEntityMapping
  • $wgWbManifestExternalServiceMapping
  • $wgWbManifestMaxLag
Quarterly downloads 2 (Ranked 131st)
Translate the WikibaseManifest extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The WikibaseManifest extension provides an API endpoint that allows for automated configuration discovery of the Wikibase it is installed on; the endpoint returns automatically discovered configuration information from the local Wikibase for use by external tools.

rest.php/wikibase-manifest/v0/manifest

Installation

edit
  • Download and move the extracted WikibaseManifest folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikibaseManifest
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'WikibaseManifest' );
    
  • Optionally set equivalent entities, max lag and external services (see below)
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

edit

Equivalent entities

edit

Optionally specify a list of entities on Wikidata that have an equivalent entity on this Wikibase.

$wgWbManifestWikidataEntityMapping = [
	'properties' => [
		'P31' => 'P1',
	],
	'items' => [
		'Q5' => 'Q15'
	],
];

Maximum lag

edit

Specify the maximum lag setting (in seconds) that automated clients of this Wikibase should follow (default: 5)

$wgWbManifestMaxLag = 7;

External services

edit

Optionally specify a list of external services and the URLs at which they can be found.

$wgWbManifestExternalServiceMapping = [
	'queryservice_ui' => 'https://query.wikidata.org',
    # queryservice is derived from Wikibase config if left out:
	'queryservice' => 'https://query.wikidata.org/sparql',
	'quickstatements' => 'https://quickstatements.toolforge.org',
	'openrefine_reconcile' => 'https://wikidata.reconci.link/${lang}/api',
];

Documentation of the valid external service names can be found in the code of the extension.

Integration with other extensions

edit

WikibaseManifest requires that Wikibase Repository is already installed.

If installed, WikibaseManifest makes use of:

If installed, WikibaseManifest will provide some OAuth information in the manifest API response