2 "$schema": "http://json-schema.org/schema#",
3 "description": "MediaWiki extension.json schema",
5 "additionalProperties": false,
9 "description": "Version of the extension.json schema the extension.json file is in.",
14 "description": "The extension's canonical name.",
19 "description": "i18n message key of the extension's name."
23 "description": "The extension's type, as an index to $wgExtensionCredits.",
31 "description": "Extension's authors.",
38 "description": "The version of this release of the extension."
42 "description": "URL to the homepage for the extension.",
43 "format": "uri-reference"
47 "description": "Raw description of the extension."
51 "description": "Message key for a i18n message describing the extension."
55 "description": "SPDX identifier for the license under which the extension is released."
59 "description": "Indicates what versions of MediaWiki core or extensions are required. This syntax may be extended in the future, for example to check dependencies between other services.",
60 "additionalProperties": false,
64 "description": "Version constraint string against MediaWiki core."
68 "description": "Set of version constraint strings against specific extensions."
72 "description": "Set of version constraint strings against specific skins."
76 "ResourceFileModulePaths": {
78 "description": "Default paths to use for all ResourceLoader file modules",
79 "additionalProperties": false,
83 "description": "Base path to prepend to all local paths, relative to current directory"
87 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
91 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
97 "description": "ResourceLoader modules to register",
98 "patternProperties": {
99 "^[a-zA-Z0-9-\\.]+$": {
103 "description": "A ResourceLoaderFileModule definition",
104 "additionalProperties": false,
108 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
112 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
116 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
120 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
123 "type": ["string", "array"],
124 "description": "Scripts to always include (array of file paths)",
131 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
132 "patternProperties": {
133 "^[a-zA-Z0-9-]{2,}$": {
146 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
147 "patternProperties": {
160 "type": ["string", "array"],
161 "description": "Scripts to include in debug contexts",
167 "type": ["string", "array"],
168 "description": "Scripts to include in the startup module",
174 "type": ["string", "array"],
175 "description": "Modules which must be loaded before this module",
181 "type": ["string", "array", "object"],
182 "description": "Styles to always load",
189 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
190 "patternProperties": {
203 "type": ["string", "array"],
204 "description": "Messages to always load",
211 "description": "Group with which this module should be loaded"
214 "type": ["object", "boolean"],
215 "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."
219 "description": "Position on the page to load this module at",
226 "type": ["object", "array"],
227 "description": "Templates to be loaded for client-side usage"
230 "type": ["string", "array"],
231 "description": "ResourceLoader target the module can run on",
238 "description": "Whether to skip CSSJanus LTR-to-RTL flipping for this module. Recommended for styles imported from libraries that already properly handle their RTL styles. Default is false, meaning CSSJanus will be applied on RTL-mode output."
243 "description": "A ResourceLoaderWikiModule definition",
244 "additionalProperties": false,
247 "enum": ["ResourceLoaderWikiModule"]
251 "description": "Group with which this module should be loaded"
255 "description": "Position on the page to load this module at",
262 "type": ["string", "array"],
263 "description": "ResourceLoader target the module can run on",
270 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
277 "description": "A list of on-wiki pages containing CSS that should be loaded",
285 "description": "A ResourceLoaderImageModule definition",
286 "additionalProperties": false,
289 "enum": ["ResourceLoaderImageModule"]
300 "selectorWithoutVariant": {
303 "selectorWithVariant": {
321 "description": "An arbitrary ResourceLoaderModule definition by class",
325 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
328 "required": ["class"]
331 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
335 "description": "A static instantiator function for creating the ResourceLoaderModule object."
338 "required": ["factory"]
344 "ResourceModuleSkinStyles": {
346 "description": "ResourceLoader modules for custom skin styles"
348 "ResourceLoaderSources": {
350 "description": "ResourceLoader sources to register"
352 "ResourceLoaderLESSVars": {
354 "description": "ResourceLoader LESS variables"
358 "description": "Registry of factory functions to create Config objects"
360 "SessionProviders": {
362 "description": "Session providers"
364 "AuthManagerAutoConfig": {
366 "description": "AuthManager auto-configuration",
367 "additionalProperties": false,
371 "description": "Pre-authentication providers"
375 "description": "Primary authentication providers"
379 "description": "Secondary authentication providers"
383 "CentralIdLookupProviders": {
385 "description": "Central ID lookup providers"
387 "ChangeCredentialsBlacklist": {
389 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
391 "RemoveCredentialsBlacklist": {
393 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
397 "description": "Method to add extra namespaces",
429 "defaultcontentmodel": {
433 "type": ["string", "array"],
434 "description": "Userright(s) required to edit in this namespace"
436 "capitallinkoverride": {
438 "description": "Set $wgCapitalLinks on a per-namespace basis"
442 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
446 "required": ["id", "constant", "name"]
449 "TrackingCategories": {
451 "description": "Tracking category message keys",
456 "DefaultUserOptions": {
458 "description": "Default values of user options"
462 "description": "Preferences users cannot set",
467 "GroupPermissions": {
469 "description": "Default permissions to give to user groups",
470 "patternProperties": {
473 "patternProperties": {
481 "RevokePermissions": {
483 "description": "Default permissions to revoke from user groups",
484 "patternProperties": {
487 "patternProperties": {
495 "GrantPermissions": {
497 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
498 "patternProperties": {
501 "patternProperties": {
509 "GrantPermissionGroups": {
511 "description": "Map of grants to their UI grouping",
512 "patternProperties": {
520 "description": "Implicit groups"
524 "description": "Groups a user can add to themselves"
526 "GroupsRemoveFromSelf": {
528 "description": "Groups a user can remove from themselves"
532 "description": "Groups a user can add to users"
536 "description": "Groups a user can remove from users"
540 "description": "User rights added by the extension",
547 "description": "Mapping of model ID to class name",
548 "patternProperties": {
556 "description": "Rate limits"
558 "RecentChangesFlags": {
560 "description": "Flags (letter symbols) shown on RecentChanges pages"
564 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
566 "ExtensionFunctions": {
571 "description": "Function to call after setup has finished",
576 "ExtensionMessagesFiles": {
578 "description": "File paths containing PHP internationalization data"
582 "description": "Directory paths containing JSON internationalization data"
584 "ExtensionEntryPointListFiles": {
589 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
591 "AutoloadNamespaces": {
593 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading"
599 "type": [ "string", "object" ],
600 "description": "Hooks this extension uses (mapping of hook name to callback)"
604 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
608 "description": "List of new log types this extension uses"
616 "ActionFilteredLogs": {
618 "description": "List of log types which can be filtered by log actions",
619 "patternProperties": {
622 "patternProperties": {
642 "LogActionsHandlers": {
651 "APIFormatModules": {
668 "description": "Available feeds objects"
672 "description": "Map of skin names to OOjs UI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
676 "description": "Password policies"
680 "description": "Preferred file extensions for uploading",
690 "description": "A function to be called right after MediaWiki processes this file"
695 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
699 "description": "Configuration options for this extension",
700 "patternProperties": {
701 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
710 "array_merge_recursive",
711 "array_replace_recursive",
716 "default": "array_merge"
719 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
724 "type": ["string", "array"],
725 "description": "A description of the config setting, mostly for documentation/developers"
729 "description": "The message key which should be used as a description for this configuration option in a user interface. If empty, description will be used."
734 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
742 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
744 "ServiceWiringFiles": {
746 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
749 "description":"Registration information for other extensions",
751 "patternProperties": {
754 "patternProperties": {
756 "type": ["array", "object"]
762 "load_composer_autoloader": {
764 "description": "Load the composer autoloader for this extension, if one is present"