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 PHP, 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": "Indicates version constraints against platform services.",
69 "additionalProperties": false,
73 "description": "Version constraint string against PHP."
79 "description": "Set of version constraint strings against specific extensions."
83 "description": "Set of version constraint strings against specific skins."
87 "ResourceFileModulePaths": {
89 "description": "Default paths to use for all ResourceLoader file modules",
90 "additionalProperties": false,
94 "description": "Base path to prepend to all local paths, relative to current directory"
98 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
102 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
108 "description": "ResourceLoader modules to register",
109 "patternProperties": {
110 "^[a-zA-Z0-9-\\.]+$": {
114 "description": "A ResourceLoaderFileModule definition",
115 "additionalProperties": false,
119 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
123 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
127 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
131 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
134 "type": ["string", "array"],
135 "description": "Scripts to always include (array of file paths)",
142 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
143 "patternProperties": {
144 "^[a-zA-Z0-9-]{2,}$": {
157 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
158 "patternProperties": {
171 "type": ["string", "array"],
172 "description": "Scripts to include in debug contexts",
178 "type": ["string", "array"],
179 "description": "Scripts to include in the startup module",
185 "type": ["string", "array"],
186 "description": "Modules which must be loaded before this module",
192 "type": ["string", "array", "object"],
193 "description": "Styles to always load",
200 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
201 "patternProperties": {
214 "type": ["string", "array"],
215 "description": "Messages to always load",
222 "description": "Group with which this module should be loaded"
225 "type": ["object", "string", "boolean"],
226 "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."
230 "description": "Position on the page to load this module at",
237 "type": ["object", "array"],
238 "description": "Templates to be loaded for client-side usage"
241 "type": ["string", "array"],
242 "description": "ResourceLoader target the module can run on",
249 "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."
254 "description": "A ResourceLoaderWikiModule definition",
255 "additionalProperties": false,
258 "enum": ["ResourceLoaderWikiModule"]
262 "description": "Group with which this module should be loaded"
266 "description": "Position on the page to load this module at",
273 "type": ["string", "array"],
274 "description": "ResourceLoader target the module can run on",
281 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
288 "description": "A list of on-wiki pages containing CSS that should be loaded",
296 "description": "A ResourceLoaderImageModule definition",
297 "additionalProperties": false,
300 "enum": ["ResourceLoaderImageModule"]
314 "selectorWithoutVariant": {
317 "selectorWithVariant": {
338 "description": "An arbitrary ResourceLoaderModule definition by class",
342 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
345 "required": ["class"]
348 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
352 "description": "A static instantiator function for creating the ResourceLoaderModule object."
355 "required": ["factory"]
361 "ResourceModuleSkinStyles": {
363 "description": "ResourceLoader modules for custom skin styles"
365 "ResourceLoaderSources": {
367 "description": "ResourceLoader sources to register"
371 "description": "Registry of factory functions to create Config objects"
373 "SessionProviders": {
375 "description": "Session providers"
377 "AuthManagerAutoConfig": {
379 "description": "AuthManager auto-configuration",
380 "additionalProperties": false,
384 "description": "Pre-authentication providers"
388 "description": "Primary authentication providers"
392 "description": "Secondary authentication providers"
396 "CentralIdLookupProviders": {
398 "description": "Central ID lookup providers"
400 "ChangeCredentialsBlacklist": {
402 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
404 "RemoveCredentialsBlacklist": {
406 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
410 "description": "Method to add extra namespaces",
442 "defaultcontentmodel": {
446 "type": ["string", "array"],
447 "description": "Userright(s) required to edit in this namespace"
449 "capitallinkoverride": {
451 "description": "Set $wgCapitalLinks on a per-namespace basis"
455 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
459 "required": ["id", "constant", "name"]
462 "TrackingCategories": {
464 "description": "Tracking category message keys",
469 "DefaultUserOptions": {
471 "description": "Default values of user options"
475 "description": "Preferences users cannot set",
480 "GroupPermissions": {
482 "description": "Default permissions to give to user groups",
483 "patternProperties": {
486 "patternProperties": {
494 "RevokePermissions": {
496 "description": "Default permissions to revoke from user groups",
497 "patternProperties": {
500 "patternProperties": {
508 "GrantPermissions": {
510 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
511 "patternProperties": {
514 "patternProperties": {
522 "GrantPermissionGroups": {
524 "description": "Map of grants to their UI grouping",
525 "patternProperties": {
533 "description": "Implicit groups"
537 "description": "Groups a user can add to themselves"
539 "GroupsRemoveFromSelf": {
541 "description": "Groups a user can remove from themselves"
545 "description": "Groups a user can add to users"
549 "description": "Groups a user can remove from users"
553 "description": "User rights added by the extension",
560 "description": "Mapping of model ID to class name",
561 "patternProperties": {
569 "description": "Rate limits"
571 "RecentChangesFlags": {
573 "description": "Flags (letter symbols) shown on RecentChanges pages"
577 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
579 "ExtensionFunctions": {
584 "description": "Function to call after setup has finished",
589 "ExtensionMessagesFiles": {
591 "description": "File paths containing PHP internationalization data"
595 "description": "Directory paths containing JSON internationalization data"
597 "ExtensionEntryPointListFiles": {
602 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
604 "AutoloadNamespaces": {
606 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
607 "patternProperties": {
608 "^[A-Za-z0-9\\\\]+\\\\$": {
612 "additionalProperties": false
618 "type": [ "string", "object" ],
619 "description": "Hooks this extension uses (mapping of hook name to callback)"
623 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
627 "description": "List of new log types this extension uses"
635 "ActionFilteredLogs": {
637 "description": "List of log types which can be filtered by log actions",
638 "patternProperties": {
641 "patternProperties": {
661 "LogActionsHandlers": {
670 "APIFormatModules": {
687 "description": "Available feeds objects"
691 "description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
695 "description": "Password policies"
699 "description": "Preferred file extensions for uploading",
706 "description": "Messages which are rendered as raw HTML",
716 "description": "A function to be called right after MediaWiki processes this file"
721 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
725 "description": "Configuration options for this extension",
726 "patternProperties": {
727 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
736 "array_merge_recursive",
737 "array_replace_recursive",
742 "default": "array_merge"
745 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
750 "type": ["string", "array"],
751 "description": "A description of the config setting, mostly for documentation/developers"
755 "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."
760 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
768 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
770 "ServiceWiringFiles": {
772 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
775 "description":"Registration information for other extensions",
777 "patternProperties": {
780 "patternProperties": {
782 "type": ["array", "object"]
788 "load_composer_autoloader": {
790 "description": "Load the composer autoloader for this extension, if one is present"