2 "$schema": "http://json-schema.org/schema#",
3 "description": "MediaWiki extension.json schema",
5 "additionalProperties": false,
9 "description": "Arbitrary notes, ignored by the parser."
15 "description": "Version of the extension.json schema the extension.json file is in.",
20 "description": "The extension's canonical name.",
25 "description": "i18n message key of the extension's name."
29 "description": "The extension's type, as an index to $wgExtensionCredits.",
37 "description": "Extension's authors.",
44 "description": "The version of this release of the extension."
48 "description": "URL to the homepage for the extension.",
49 "format": "uri-reference"
53 "description": "Raw description of the extension."
57 "description": "Message key for a i18n message describing the extension."
61 "description": "SPDX identifier for the license under which the extension is released."
65 "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.",
66 "additionalProperties": false,
70 "description": "Version constraint string against MediaWiki core."
74 "description": "Indicates version constraints against platform services.",
75 "additionalProperties": false,
79 "description": "Version constraint string against PHP."
84 "description": "Whether this extension requires shell access."
87 "patternProperties": {
90 "description": "Required PHP extension.",
97 "description": "Set of version constraint strings against specific extensions."
101 "description": "Set of version constraint strings against specific skins."
107 "description": "Indicates what dependencies are required for development purposes such as running tests. This syntax may be extended in the future.",
108 "additionalProperties": false,
112 "description": "Version constraint string against MediaWiki core."
116 "description": "Indicates version constraints against platform services.",
117 "additionalProperties": false,
121 "description": "Version constraint string against PHP."
126 "description": "Whether this extension requires shell access."
129 "patternProperties": {
132 "description": "Required PHP extension.",
139 "description": "Set of version constraint strings against specific extensions."
143 "description": "Set of version constraint strings against specific skins."
147 "ResourceFileModulePaths": {
149 "description": "Default paths to use for all ResourceLoader file modules",
150 "additionalProperties": false,
154 "description": "Base path to prepend to all local paths, relative to current directory"
158 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
162 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
168 "description": "ResourceLoader modules to register",
169 "patternProperties": {
170 "^[a-zA-Z0-9-\\.]+$": {
174 "description": "A ResourceLoaderFileModule definition",
175 "additionalProperties": false,
179 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
183 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
187 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
191 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
194 "type": ["string", "array"],
195 "description": "Scripts to always include (array of file paths)",
202 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
203 "patternProperties": {
204 "^[a-zA-Z0-9-]{2,}$": {
217 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
218 "patternProperties": {
231 "type": ["string", "array"],
232 "description": "Scripts to include in debug contexts",
238 "type": ["string", "array"],
239 "description": "Scripts to include in the startup module",
245 "type": ["string", "array"],
246 "description": "Modules which must be loaded before this module",
252 "type": ["string", "array", "object"],
253 "description": "Styles to always load",
260 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
261 "patternProperties": {
274 "type": ["string", "array"],
275 "description": "Messages to always load",
282 "description": "Group with which this module should be loaded"
285 "type": ["object", "string", "boolean"],
286 "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."
290 "description": "Position on the page to load this module at",
297 "type": ["object", "array"],
298 "description": "Templates to be loaded for client-side usage"
301 "type": ["string", "array"],
302 "description": "ResourceLoader target the module can run on",
309 "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."
312 "type": ["object", "array"],
313 "description": "Package files that can be require()d"
318 "description": "A ResourceLoaderWikiModule definition",
319 "additionalProperties": false,
322 "enum": ["ResourceLoaderWikiModule"]
326 "description": "Group with which this module should be loaded"
330 "description": "Position on the page to load this module at",
337 "type": ["string", "array"],
338 "description": "ResourceLoader target the module can run on",
345 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
352 "description": "A list of on-wiki pages containing CSS that should be loaded",
360 "description": "A ResourceLoaderImageModule definition",
361 "additionalProperties": false,
364 "enum": ["ResourceLoaderImageModule"]
378 "selectorWithoutVariant": {
381 "selectorWithVariant": {
402 "description": "An arbitrary ResourceLoaderModule definition by class",
406 "pattern": "^(?!ResourceLoader(File|Image|Wiki)Module).*$"
409 "required": ["class"]
412 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
416 "description": "A static instantiator function for creating the ResourceLoaderModule object."
419 "required": ["factory"]
425 "ResourceModuleSkinStyles": {
427 "description": "ResourceLoader modules for custom skin styles"
429 "ResourceLoaderSources": {
431 "description": "ResourceLoader sources to register"
435 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true.",
436 "additionalProperties": false,
440 "description": "Prefix for local paths to files in $options, relative to extenion directory"
444 "description": "Prefix for URLs to files in $options, relative to $wgExtensionAssetsPath"
448 "description": "Prefix for URLs to files in $options, relative to $wgStylePath"
451 "type": ["string", "array"],
452 "description": "Scripts to include (array of file paths)",
458 "type": ["string", "array"],
459 "description": "Modules which must be loaded before this module",
465 "type": ["string", "array", "object"],
466 "description": "Styles to load",
472 "type": ["string", "array"],
473 "description": "Messages to load",
482 "description": "Registry of factory functions to create Config objects"
484 "SessionProviders": {
486 "description": "Session providers"
488 "AuthManagerAutoConfig": {
490 "description": "AuthManager auto-configuration",
491 "additionalProperties": false,
495 "description": "Pre-authentication providers"
499 "description": "Primary authentication providers"
503 "description": "Secondary authentication providers"
507 "CentralIdLookupProviders": {
509 "description": "Central ID lookup providers"
511 "ChangeCredentialsBlacklist": {
513 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
515 "RemoveCredentialsBlacklist": {
517 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
521 "description": "Method to add extra namespaces",
553 "defaultcontentmodel": {
557 "type": ["string", "array"],
558 "description": "Userright(s) required to edit in this namespace"
560 "capitallinkoverride": {
562 "description": "Set $wgCapitalLinks on a per-namespace basis"
566 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
570 "required": ["id", "constant", "name"]
573 "TrackingCategories": {
575 "description": "Tracking category message keys",
580 "DefaultUserOptions": {
582 "description": "Default values of user options"
586 "description": "Preferences users cannot set",
591 "GroupPermissions": {
593 "description": "Default permissions to give to user groups",
594 "patternProperties": {
597 "patternProperties": {
605 "RevokePermissions": {
607 "description": "Default permissions to revoke from user groups",
608 "patternProperties": {
611 "patternProperties": {
619 "GrantPermissions": {
621 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
622 "patternProperties": {
625 "patternProperties": {
633 "GrantPermissionGroups": {
635 "description": "Map of grants to their UI grouping",
636 "patternProperties": {
644 "description": "Implicit groups"
648 "description": "Groups a user can add to themselves"
650 "GroupsRemoveFromSelf": {
652 "description": "Groups a user can remove from themselves"
656 "description": "Groups a user can add to users"
660 "description": "Groups a user can remove from users"
664 "description": "User rights added by the extension",
671 "description": "Mapping of model ID to class name",
672 "patternProperties": {
680 "description": "Rate limits"
682 "RecentChangesFlags": {
684 "description": "Flags (letter symbols) shown on RecentChanges pages"
688 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
690 "ExtensionFunctions": {
695 "description": "Function to call after setup has finished",
700 "ExtensionMessagesFiles": {
702 "description": "File paths containing PHP internationalization data"
706 "description": "Directory paths containing JSON internationalization data"
708 "ExtensionEntryPointListFiles": {
713 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
715 "AutoloadNamespaces": {
717 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
718 "patternProperties": {
719 "^[A-Za-z0-9\\\\]+\\\\$": {
723 "additionalProperties": false
729 "type": [ "string", "object" ],
730 "description": "Hooks this extension uses (mapping of hook name to callback)"
734 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
738 "description": "List of new log types this extension uses"
746 "ActionFilteredLogs": {
748 "description": "List of log types which can be filtered by log actions",
749 "patternProperties": {
752 "patternProperties": {
772 "LogActionsHandlers": {
781 "APIFormatModules": {
798 "description": "Available feeds objects"
802 "description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
806 "description": "Password policies"
810 "description": "Preferred file extensions for uploading",
817 "description": "Messages which are rendered as raw HTML",
822 "ReauthenticateTime": {
824 "patternProperties": {
835 "description": "A function to be called right after MediaWiki processes this file"
840 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
844 "description": "Configuration options for this extension",
845 "patternProperties": {
846 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
855 "array_merge_recursive",
856 "array_replace_recursive",
861 "default": "array_merge"
864 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
869 "type": ["string", "array"],
870 "description": "A description of the config setting, mostly for documentation/developers"
874 "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."
879 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
887 "description": "DEPRECATED: Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
889 "ServiceWiringFiles": {
891 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
894 "description":"Registration information for other extensions",
896 "patternProperties": {
899 "patternProperties": {
901 "type": ["array", "object"]
907 "load_composer_autoloader": {
909 "description": "Load the composer autoloader for this extension, if one is present"