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 PHP, 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": "Indicates version constraints against platform services.",
68 "additionalProperties": false,
72 "description": "Version constraint string against PHP."
77 "description": "Whether this extension requires shell access."
80 "patternProperties": {
83 "description": "Required PHP extension.",
90 "description": "Set of version constraint strings against specific extensions."
94 "description": "Set of version constraint strings against specific skins."
100 "description": "Indicates what dependencies are required for development purposes such as running tests. This syntax may be extended in the future.",
101 "additionalProperties": false,
105 "description": "Version constraint string against MediaWiki core."
109 "description": "Indicates version constraints against platform services.",
110 "additionalProperties": false,
114 "description": "Version constraint string against PHP."
119 "description": "Whether this extension requires shell access."
122 "patternProperties": {
125 "description": "Required PHP extension.",
132 "description": "Set of version constraint strings against specific extensions."
136 "description": "Set of version constraint strings against specific skins."
140 "ResourceFileModulePaths": {
142 "description": "Default paths to use for all ResourceLoader file modules",
143 "additionalProperties": false,
147 "description": "Base path to prepend to all local paths, relative to current directory"
151 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
155 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
161 "description": "ResourceLoader modules to register",
162 "patternProperties": {
163 "^[a-zA-Z0-9-\\.]+$": {
167 "description": "A ResourceLoaderFileModule definition",
168 "additionalProperties": false,
172 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
176 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
180 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
184 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
187 "type": ["string", "array"],
188 "description": "Scripts to always include (array of file paths)",
195 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
196 "patternProperties": {
197 "^[a-zA-Z0-9-]{2,}$": {
210 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
211 "patternProperties": {
224 "type": ["string", "array"],
225 "description": "Scripts to include in debug contexts",
231 "type": ["string", "array"],
232 "description": "Scripts to include in the startup module",
238 "type": ["string", "array"],
239 "description": "Modules which must be loaded before this module",
245 "type": ["string", "array", "object"],
246 "description": "Styles to always load",
253 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
254 "patternProperties": {
267 "type": ["string", "array"],
268 "description": "Messages to always load",
275 "description": "Group which this module should be loaded together with"
278 "type": ["object", "string", "boolean"],
279 "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."
283 "description": "Position on the page to load this module at",
290 "type": ["object", "array"],
291 "description": "Templates to be loaded for client-side usage"
294 "type": ["string", "array"],
295 "description": "ResourceLoader target the module can run on",
302 "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."
305 "type": ["object", "array"],
306 "description": "Package files that can be require()d"
311 "description": "A ResourceLoaderWikiModule definition",
312 "additionalProperties": false,
315 "enum": ["ResourceLoaderWikiModule"]
319 "description": "Group which this module should be loaded together with"
323 "description": "Position on the page to load this module at",
330 "type": ["string", "array"],
331 "description": "ResourceLoader target the module can run on",
351 "description": "A ResourceLoaderImageModule definition",
352 "additionalProperties": false,
355 "enum": ["ResourceLoaderImageModule"]
369 "selectorWithoutVariant": {
372 "selectorWithVariant": {
393 "description": "An arbitrary ResourceLoaderModule definition",
397 "pattern": "^(?!ResourceLoader(File|Image|Wiki)Module).*$"
400 "required": ["class"]
406 "ResourceModuleSkinStyles": {
408 "description": "ResourceLoader modules for custom skin styles"
410 "ResourceLoaderSources": {
412 "description": "ResourceLoader sources to register"
416 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true."
420 "description": "Registry of factory functions to create Config objects"
422 "SessionProviders": {
424 "description": "Session providers"
426 "AuthManagerAutoConfig": {
428 "description": "AuthManager auto-configuration",
429 "additionalProperties": false,
433 "description": "Pre-authentication providers"
437 "description": "Primary authentication providers"
441 "description": "Secondary authentication providers"
445 "CentralIdLookupProviders": {
447 "description": "Central ID lookup providers"
451 "description": "Method to add extra namespaces",
483 "defaultcontentmodel": {
487 "type": ["string", "array"],
488 "description": "Userright(s) required to edit in this namespace"
490 "capitallinkoverride": {
492 "description": "Set $wgCapitalLinks on a per-namespace basis"
496 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
500 "required": ["id", "constant", "name"]
503 "TrackingCategories": {
505 "description": "Tracking category message keys",
510 "DefaultUserOptions": {
512 "description": "Default values of user options"
516 "description": "Preferences users cannot set",
521 "GroupPermissions": {
523 "description": "Default permissions to give to user groups",
524 "patternProperties": {
527 "patternProperties": {
535 "RevokePermissions": {
537 "description": "Default permissions to revoke from user groups",
538 "patternProperties": {
541 "patternProperties": {
549 "GrantPermissions": {
551 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
552 "patternProperties": {
555 "patternProperties": {
563 "GrantPermissionGroups": {
565 "description": "Map of grants to their UI grouping",
566 "patternProperties": {
574 "description": "Implicit groups"
578 "description": "Groups a user can add to themselves"
580 "GroupsRemoveFromSelf": {
582 "description": "Groups a user can remove from themselves"
586 "description": "Groups a user can add to users"
590 "description": "Groups a user can remove from users"
594 "description": "User rights added by the extension",
601 "description": "Mapping of model ID to class name",
602 "patternProperties": {
610 "description": "Rate limits"
612 "RecentChangesFlags": {
614 "description": "Flags (letter symbols) shown on RecentChanges pages"
618 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
620 "ExtensionFunctions": {
625 "description": "Function to call after setup has finished",
630 "ExtensionMessagesFiles": {
632 "description": "File paths containing PHP internationalization data"
636 "description": "Directory paths containing JSON internationalization data"
638 "ExtensionEntryPointListFiles": {
643 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
645 "AutoloadNamespaces": {
647 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
648 "patternProperties": {
649 "^[A-Za-z0-9\\\\]+\\\\$": {
653 "additionalProperties": false
659 "type": [ "string", "object" ],
660 "description": "Hooks this extension uses (mapping of hook name to callback)"
664 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
668 "description": "List of new log types this extension uses"
676 "ActionFilteredLogs": {
678 "description": "List of log types which can be filtered by log actions",
679 "patternProperties": {
682 "patternProperties": {
702 "LogActionsHandlers": {
711 "APIFormatModules": {
728 "description": "Available feeds objects"
735 "description": "Map of custom OOUI theme names to paths to load them from. Same format as ResourceLoaderOOUIModule::$builtinThemePaths.",
736 "patternProperties": {
739 "additionalProperties": false,
743 "description": "Path to script file."
747 "description": "Path to style files. '{module}' will be replaced with the module's name."
750 "type": [ "string", "null" ],
751 "description": "Path to images (optional). '{module}' will be replaced with the module's name."
759 "description": "Password policies"
763 "description": "Preferred file extensions for uploading",
770 "description": "Messages which are rendered as raw HTML",
775 "ReauthenticateTime": {
777 "patternProperties": {
788 "description": "A function to be called right after MediaWiki processes this file"
792 "description": "Configuration options for this extension",
797 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
800 "patternProperties": {
801 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
806 "array_merge_recursive",
807 "array_replace_recursive",
812 "default": "array_merge"
820 "description": "DEPRECATED: Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
822 "ServiceWiringFiles": {
824 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
826 "load_composer_autoloader": {
828 "description": "Load the composer autoloader for this extension, if one is present"