Extension:WikibaseManifest

From mediawiki.org
Jump to navigation Jump to search


MediaWiki extensions manual
OOjs UI icon advanced.svg
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 backwards compatible.
MediaWiki master
MediaWiki 1.36 Not formally tested
MediaWiki 1.34 Not formally tested
MediaWiki 1.32 Not formally tested
Database changes No
License GNU General Public License 2.0 or later
Download
readme

  • $wgWbManifestWikidataEntityMapping
  • $wgWbManifestExternalServiceMapping
  • $wgWbManifestMaxLag
Translate the WikibaseManifest extension if it is available at translatewiki.net

Check usage and version matrix.

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.

Installation[edit]

  • Download and place the file(s) in a directory called WikibaseManifest in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'WikibaseManifest' );
    
  • Optionally set equivalent entities, max lag and external services (see below)
  • Yes 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',
];

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

Integration with other extensions[edit]

WikibaseManifest requires that WikibaseRepo is already installed.

If installed, WikibaseManifest makes use of:

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