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.",
42 "format": "uri-reference"
46 "description": "Raw description of the extension."
50 "description": "Message key for a i18n message describing the extension."
54 "description": "SPDX identifier for the license under which the extension is released."
58 "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.",
59 "additionalProperties": false,
63 "description": "Version constraint string against MediaWiki core."
67 "description": "Set of version constraint strings against specific extensions."
71 "description": "Set of version constraint strings against specific skins."
75 "ResourceFileModulePaths": {
77 "description": "Default paths to use for all ResourceLoader file modules",
78 "additionalProperties": false,
82 "description": "Base path to prepend to all local paths, relative to current directory"
86 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
90 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
96 "description": "ResourceLoader modules to register",
97 "patternProperties": {
98 "^[a-zA-Z0-9-\\.]+$": {
102 "description": "A ResourceLoaderFileModule definition",
103 "additionalProperties": false,
107 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
111 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
115 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
119 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
122 "type": ["string", "array"],
123 "description": "Scripts to always include (array of file paths)",
130 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
131 "patternProperties": {
132 "^[a-zA-Z0-9-]{2,}$": {
145 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
146 "patternProperties": {
159 "type": ["string", "array"],
160 "description": "Scripts to include in debug contexts",
166 "type": ["string", "array"],
167 "description": "Scripts to include in the startup module",
173 "type": ["string", "array"],
174 "description": "Modules which must be loaded before this module",
180 "type": ["string", "array", "object"],
181 "description": "Styles to always load",
188 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
189 "patternProperties": {
202 "type": ["string", "array"],
203 "description": "Messages to always load",
210 "description": "Group which this module should be loaded together with"
213 "type": ["object", "string", "boolean"],
214 "description": "Whether the module is deprecated and usage is discouraged. Either a boolean, or a string or an object with key message can be used to customise deprecation message."
218 "description": "Position on the page to load this module at",
225 "type": ["object", "array"],
226 "description": "Templates to be loaded for client-side usage"
229 "type": ["string", "array"],
230 "description": "ResourceLoader target the module can run on",
237 "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."
242 "description": "A ResourceLoaderWikiModule definition",
243 "additionalProperties": false,
246 "enum": ["ResourceLoaderWikiModule"]
250 "description": "Group which this module should be loaded together with"
254 "description": "Position on the page to load this module at",
261 "type": ["string", "array"],
262 "description": "ResourceLoader target the module can run on",
282 "description": "A ResourceLoaderImageModule definition",
283 "additionalProperties": false,
286 "enum": ["ResourceLoaderImageModule"]
300 "selectorWithoutVariant": {
303 "selectorWithVariant": {
321 "description": "An arbitrary ResourceLoaderModule definition",
325 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
328 "required": ["class"]
334 "ResourceModuleSkinStyles": {
336 "description": "ResourceLoader modules for custom skin styles"
338 "ResourceLoaderSources": {
340 "description": "ResourceLoader sources to register"
342 "ResourceLoaderLESSVars": {
344 "description": "ResourceLoader LESS variables"
348 "description": "Registry of factory functions to create Config objects"
350 "SessionProviders": {
352 "description": "Session providers"
354 "AuthManagerAutoConfig": {
356 "description": "AuthManager auto-configuration",
357 "additionalProperties": false,
361 "description": "Pre-authentication providers"
365 "description": "Primary authentication providers"
369 "description": "Secondary authentication providers"
373 "CentralIdLookupProviders": {
375 "description": "Central ID lookup providers"
379 "description": "Method to add extra namespaces",
411 "defaultcontentmodel": {
415 "type": ["string", "array"],
416 "description": "Userright(s) required to edit in this namespace"
418 "capitallinkoverride": {
420 "description": "Set $wgCapitalLinks on a per-namespace basis"
424 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
428 "required": ["id", "constant", "name"]
431 "TrackingCategories": {
433 "description": "Tracking category message keys",
438 "DefaultUserOptions": {
440 "description": "Default values of user options"
444 "description": "Preferences users cannot set",
449 "GroupPermissions": {
451 "description": "Default permissions to give to user groups",
452 "patternProperties": {
455 "patternProperties": {
463 "RevokePermissions": {
465 "description": "Default permissions to revoke from user groups",
466 "patternProperties": {
469 "patternProperties": {
477 "GrantPermissions": {
479 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
480 "patternProperties": {
483 "patternProperties": {
491 "GrantPermissionGroups": {
493 "description": "Map of grants to their UI grouping",
494 "patternProperties": {
502 "description": "Implicit groups"
506 "description": "Groups a user can add to themselves"
508 "GroupsRemoveFromSelf": {
510 "description": "Groups a user can remove from themselves"
514 "description": "Groups a user can add to users"
518 "description": "Groups a user can remove from users"
522 "description": "User rights added by the extension",
529 "description": "Mapping of model ID to class name",
530 "patternProperties": {
538 "description": "Rate limits"
540 "RecentChangesFlags": {
542 "description": "Flags (letter symbols) shown on RecentChanges pages"
546 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
548 "ExtensionFunctions": {
553 "description": "Function to call after setup has finished",
558 "ExtensionMessagesFiles": {
560 "description": "File paths containing PHP internationalization data"
564 "description": "Directory paths containing JSON internationalization data"
566 "ExtensionEntryPointListFiles": {
571 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
573 "AutoloadNamespaces": {
575 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
576 "patternProperties": {
577 "^[A-Za-z0-9\\\\]+\\\\$": {
581 "additionalProperties": false
587 "type": [ "string", "object" ],
588 "description": "Hooks this extension uses (mapping of hook name to callback)"
592 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
596 "description": "List of new log types this extension uses"
604 "ActionFilteredLogs": {
606 "description": "List of log types which can be filtered by log actions",
607 "patternProperties": {
610 "patternProperties": {
630 "LogActionsHandlers": {
639 "APIFormatModules": {
656 "description": "Available feeds objects"
663 "description": "Password policies"
667 "description": "Preferred file extensions for uploading",
677 "description": "A function to be called right after MediaWiki processes this file"
681 "description": "Configuration options for this extension",
686 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
689 "patternProperties": {
690 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
695 "array_merge_recursive",
696 "array_replace_recursive",
701 "default": "array_merge"
709 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
711 "ServiceWiringFiles": {
713 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
715 "load_composer_autoloader": {
717 "description": "Load the composer autoloader for this extension, if one is present"