2 "$schema": "http://json-schema.org/schema#",
3 "description": "MediaWiki extension.json schema",
8 "description": "Version of the extension.json schema the extension.json file is in.",
13 "description": "The extension's canonical name.",
18 "description": "i18n message key of the extension's name."
22 "description": "The extension's type, as an index to $wgExtensionCredits.",
30 "description": "Extension's authors.",
37 "description": "The version of this release of the extension."
41 "description": "URL to the homepage for the extension.",
46 "description": "Raw description of the extension."
50 "description": "Message key for a i18n message describing the extension."
54 "description": "Short identifier for the license under which the extension is released.",
80 "BSD-2-Clause-FreeBSD",
81 "BSD-2-Clause-NetBSD",
93 "CNRI-Python-GPL-Compatible",
152 "GPL-2.0-with-autoconf-exception",
153 "GPL-2.0-with-bison-exception",
154 "GPL-2.0-with-classpath-exception",
155 "GPL-2.0-with-font-exception",
156 "GPL-2.0-with-GCC-exception",
159 "GPL-3.0-with-autoconf-exception",
160 "GPL-3.0-with-GCC-exception",
193 "MPL-2.0-no-copyleft-exception",
275 "description": "Indicates what versions of MediaWiki core are required. This syntax may be extended in the future, for example to check dependencies between other extensions.",
279 "description": "Version constraint string against MediaWiki core."
283 "ResourceFileModulePaths": {
285 "description": "Default paths to use for all ResourceLoader file modules",
286 "additionalProperties": false,
290 "description": "Base path to prepend to all local paths, relative to current directory"
294 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
298 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
304 "description": "ResourceLoader modules to register",
305 "patternProperties": {
306 "^[a-zA-Z0-9-\\.]+$": {
310 "description": "A ResourceLoaderFileModule definition",
311 "additionalProperties": false,
315 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
319 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
323 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
327 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
330 "type": ["string", "array"],
331 "description": "Scripts to always include (array of file paths)",
338 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
339 "patternProperties": {
340 "^[a-zA-Z0-9-]{2,}$": {
353 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
354 "patternProperties": {
367 "type": ["string", "array"],
368 "description": "Scripts to include in debug contexts",
374 "type": ["string", "array"],
375 "description": "Scripts to include in the startup module",
381 "type": ["string", "array"],
382 "description": "Modules which must be loaded before this module",
388 "type": ["string", "array", "object"],
389 "description": "Styles to always load",
396 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
397 "patternProperties": {
410 "type": ["string", "array"],
411 "description": "Messages to always load",
418 "description": "Group with which this module should be loaded"
421 "type": ["object", "boolean"],
422 "description": "Whether the module is deprecated and usage is discouraged. Either a boolean or an object with key message can be used to customise deprecation message."
426 "description": "Position on the page to load this module at",
433 "type": ["object", "array"],
434 "description": "Templates to be loaded for client-side usage"
437 "type": ["string", "array"],
438 "description": "ResourceLoader target the module can run on",
446 "description": "A ResourceLoaderWikiModule definition",
447 "additionalProperties": false,
450 "enum": ["ResourceLoaderWikiModule"]
454 "description": "Group with which this module should be loaded"
458 "description": "Position on the page to load this module at",
465 "type": ["string", "array"],
466 "description": "ResourceLoader target the module can run on",
473 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
480 "description": "A list of on-wiki pages containing CSS that should be loaded",
488 "description": "A ResourceLoaderImageModule definition",
489 "additionalProperties": false,
492 "enum": ["ResourceLoaderImageModule"]
503 "selectorWithoutVariant": {
506 "selectorWithVariant": {
524 "description": "An arbitrary ResourceLoaderModule definition",
528 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
531 "required": ["class"]
537 "ResourceModuleSkinStyles": {
539 "description": "ResourceLoader modules for custom skin styles"
541 "ResourceLoaderSources": {
543 "description": "ResourceLoader sources to register"
545 "ResourceLoaderLESSVars": {
547 "description": "ResourceLoader LESS variables"
551 "description": "Registry of factory functions to create Config objects"
553 "SessionProviders": {
555 "description": "Session providers"
557 "AuthManagerAutoConfig": {
559 "description": "AuthManager auto-configuration",
560 "additionalProperties": false,
564 "description": "Pre-authentication providers"
568 "description": "Primary authentication providers"
572 "description": "Secondary authentication providers"
576 "CentralIdLookupProviders": {
578 "description": "Central ID lookup providers"
580 "ChangeCredentialsBlacklist": {
582 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
584 "RemoveCredentialsBlacklist": {
586 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
590 "description": "Method to add extra namespaces",
622 "defaultcontentmodel": {
626 "type": ["string", "array"],
627 "description": "Userright(s) required to edit in this namespace"
629 "capitallinkoverride": {
631 "description": "Set $wgCapitalLinks on a per-namespace basis"
635 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
639 "required": ["id", "constant", "name"]
642 "TrackingCategories": {
644 "description": "Tracking category message keys",
649 "DefaultUserOptions": {
651 "description": "Default values of user options"
655 "description": "Preferences users cannot set",
660 "GroupPermissions": {
662 "description": "Default permissions to give to user groups",
663 "patternProperties": {
666 "patternProperties": {
674 "RevokePermissions": {
676 "description": "Default permissions to revoke from user groups",
677 "patternProperties": {
680 "patternProperties": {
688 "GrantPermissions": {
690 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
691 "patternProperties": {
694 "patternProperties": {
702 "GrantPermissionGroups": {
704 "description": "Map of grants to their UI grouping",
705 "patternProperties": {
713 "description": "Implicit groups"
717 "description": "Groups a user can add to themselves"
719 "GroupsRemoveFromSelf": {
721 "description": "Groups a user can remove from themselves"
725 "description": "Groups a user can add to users"
729 "description": "Groups a user can remove from users"
733 "description": "User rights added by the extension",
740 "description": "Mapping of model ID to class name",
741 "patternProperties": {
749 "description": "Rate limits"
751 "RecentChangesFlags": {
753 "description": "Flags (letter symbols) shown on RecentChanges pages"
757 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
759 "ExtensionFunctions": {
764 "description": "Function to call after setup has finished",
769 "ExtensionMessagesFiles": {
771 "description": "File paths containing PHP internationalization data"
775 "description": "Directory paths containing JSON internationalization data"
777 "ExtensionEntryPointListFiles": {
782 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
788 "type": [ "string", "object" ],
789 "description": "Hooks this extension uses (mapping of hook name to callback)"
793 "description": "Job types this extension implements (mapping of job type to class name)"
797 "description": "List of new log types this extension uses"
805 "ActionFilteredLogs": {
807 "description": "List of log types which can be filtered by log actions",
808 "patternProperties": {
811 "patternProperties": {
831 "LogActionsHandlers": {
840 "APIFormatModules": {
857 "description": "Available feeds objects"
867 "description": "A function to be called right after MediaWiki processes this file"
872 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
876 "description": "Configuration options for this extension",
877 "patternProperties": {
878 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
887 "array_merge_recursive",
892 "default": "array_merge"
895 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
900 "type": ["string", "array"],
901 "description": "A description of the config setting, mostly for documentation/developers"
909 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
911 "ServiceWiringFiles": {
913 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
915 "load_composer_autoloader": {
917 "description": "Load the composer autoloader for this extension, if one is present"