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."
78 "description": "Set of version constraint strings against specific extensions."
82 "description": "Set of version constraint strings against specific skins."
86 "ResourceFileModulePaths": {
88 "description": "Default paths to use for all ResourceLoader file modules",
89 "additionalProperties": false,
93 "description": "Base path to prepend to all local paths, relative to current directory"
97 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
101 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
107 "description": "ResourceLoader modules to register",
108 "patternProperties": {
109 "^[a-zA-Z0-9-\\.]+$": {
113 "description": "A ResourceLoaderFileModule definition",
114 "additionalProperties": false,
118 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
122 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
126 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
130 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
133 "type": ["string", "array"],
134 "description": "Scripts to always include (array of file paths)",
141 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
142 "patternProperties": {
143 "^[a-zA-Z0-9-]{2,}$": {
156 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
157 "patternProperties": {
170 "type": ["string", "array"],
171 "description": "Scripts to include in debug contexts",
177 "type": ["string", "array"],
178 "description": "Scripts to include in the startup module",
184 "type": ["string", "array"],
185 "description": "Modules which must be loaded before this module",
191 "type": ["string", "array", "object"],
192 "description": "Styles to always load",
199 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
200 "patternProperties": {
213 "type": ["string", "array"],
214 "description": "Messages to always load",
221 "description": "Group which this module should be loaded together with"
224 "type": ["object", "string", "boolean"],
225 "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."
229 "description": "Position on the page to load this module at",
236 "type": ["object", "array"],
237 "description": "Templates to be loaded for client-side usage"
240 "type": ["string", "array"],
241 "description": "ResourceLoader target the module can run on",
248 "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."
253 "description": "A ResourceLoaderWikiModule definition",
254 "additionalProperties": false,
257 "enum": ["ResourceLoaderWikiModule"]
261 "description": "Group which this module should be loaded together with"
265 "description": "Position on the page to load this module at",
272 "type": ["string", "array"],
273 "description": "ResourceLoader target the module can run on",
293 "description": "A ResourceLoaderImageModule definition",
294 "additionalProperties": false,
297 "enum": ["ResourceLoaderImageModule"]
311 "selectorWithoutVariant": {
314 "selectorWithVariant": {
335 "description": "An arbitrary ResourceLoaderModule definition",
339 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
342 "required": ["class"]
348 "ResourceModuleSkinStyles": {
350 "description": "ResourceLoader modules for custom skin styles"
352 "ResourceLoaderSources": {
354 "description": "ResourceLoader sources to register"
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"
389 "description": "Method to add extra namespaces",
421 "defaultcontentmodel": {
425 "type": ["string", "array"],
426 "description": "Userright(s) required to edit in this namespace"
428 "capitallinkoverride": {
430 "description": "Set $wgCapitalLinks on a per-namespace basis"
434 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
438 "required": ["id", "constant", "name"]
441 "TrackingCategories": {
443 "description": "Tracking category message keys",
448 "DefaultUserOptions": {
450 "description": "Default values of user options"
454 "description": "Preferences users cannot set",
459 "GroupPermissions": {
461 "description": "Default permissions to give to user groups",
462 "patternProperties": {
465 "patternProperties": {
473 "RevokePermissions": {
475 "description": "Default permissions to revoke from user groups",
476 "patternProperties": {
479 "patternProperties": {
487 "GrantPermissions": {
489 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
490 "patternProperties": {
493 "patternProperties": {
501 "GrantPermissionGroups": {
503 "description": "Map of grants to their UI grouping",
504 "patternProperties": {
512 "description": "Implicit groups"
516 "description": "Groups a user can add to themselves"
518 "GroupsRemoveFromSelf": {
520 "description": "Groups a user can remove from themselves"
524 "description": "Groups a user can add to users"
528 "description": "Groups a user can remove from users"
532 "description": "User rights added by the extension",
539 "description": "Mapping of model ID to class name",
540 "patternProperties": {
548 "description": "Rate limits"
550 "RecentChangesFlags": {
552 "description": "Flags (letter symbols) shown on RecentChanges pages"
556 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
558 "ExtensionFunctions": {
563 "description": "Function to call after setup has finished",
568 "ExtensionMessagesFiles": {
570 "description": "File paths containing PHP internationalization data"
574 "description": "Directory paths containing JSON internationalization data"
576 "ExtensionEntryPointListFiles": {
581 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
583 "AutoloadNamespaces": {
585 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
586 "patternProperties": {
587 "^[A-Za-z0-9\\\\]+\\\\$": {
591 "additionalProperties": false
597 "type": [ "string", "object" ],
598 "description": "Hooks this extension uses (mapping of hook name to callback)"
602 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
606 "description": "List of new log types this extension uses"
614 "ActionFilteredLogs": {
616 "description": "List of log types which can be filtered by log actions",
617 "patternProperties": {
620 "patternProperties": {
640 "LogActionsHandlers": {
649 "APIFormatModules": {
666 "description": "Available feeds objects"
673 "description": "Password policies"
677 "description": "Preferred file extensions for uploading",
684 "description": "Messages which are rendered as raw HTML",
694 "description": "A function to be called right after MediaWiki processes this file"
698 "description": "Configuration options for this extension",
703 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
706 "patternProperties": {
707 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
712 "array_merge_recursive",
713 "array_replace_recursive",
718 "default": "array_merge"
726 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
728 "ServiceWiringFiles": {
730 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
732 "load_composer_autoloader": {
734 "description": "Load the composer autoloader for this extension, if one is present"