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."
105 "ResourceFileModulePaths": {
107 "description": "Default paths to use for all ResourceLoader file modules",
108 "additionalProperties": false,
112 "description": "Base path to prepend to all local paths, relative to current directory"
116 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
120 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
126 "description": "ResourceLoader modules to register",
127 "patternProperties": {
128 "^[a-zA-Z0-9-\\.]+$": {
132 "description": "A ResourceLoaderFileModule definition",
133 "additionalProperties": false,
137 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
141 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
145 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
149 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
152 "type": ["string", "array"],
153 "description": "Scripts to always include (array of file paths)",
160 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
161 "patternProperties": {
162 "^[a-zA-Z0-9-]{2,}$": {
175 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
176 "patternProperties": {
189 "type": ["string", "array"],
190 "description": "Scripts to include in debug contexts",
196 "type": ["string", "array"],
197 "description": "Scripts to include in the startup module",
203 "type": ["string", "array"],
204 "description": "Modules which must be loaded before this module",
210 "type": ["string", "array", "object"],
211 "description": "Styles to always load",
218 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
219 "patternProperties": {
232 "type": ["string", "array"],
233 "description": "Messages to always load",
240 "description": "Group with which this module should be loaded"
243 "type": ["object", "string", "boolean"],
244 "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."
248 "description": "Position on the page to load this module at",
255 "type": ["object", "array"],
256 "description": "Templates to be loaded for client-side usage"
259 "type": ["string", "array"],
260 "description": "ResourceLoader target the module can run on",
267 "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."
270 "type": ["object", "array"],
271 "description": "Package files that can be require()d"
276 "description": "A ResourceLoaderWikiModule definition",
277 "additionalProperties": false,
280 "enum": ["ResourceLoaderWikiModule"]
284 "description": "Group with which this module should be loaded"
288 "description": "Position on the page to load this module at",
295 "type": ["string", "array"],
296 "description": "ResourceLoader target the module can run on",
303 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
310 "description": "A list of on-wiki pages containing CSS that should be loaded",
318 "description": "A ResourceLoaderImageModule definition",
319 "additionalProperties": false,
322 "enum": ["ResourceLoaderImageModule"]
336 "selectorWithoutVariant": {
339 "selectorWithVariant": {
360 "description": "An arbitrary ResourceLoaderModule definition by class",
364 "pattern": "^(?!ResourceLoader(File|Image|Wiki)Module).*$"
367 "required": ["class"]
370 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
374 "description": "A static instantiator function for creating the ResourceLoaderModule object."
377 "required": ["factory"]
383 "ResourceModuleSkinStyles": {
385 "description": "ResourceLoader modules for custom skin styles"
387 "ResourceLoaderSources": {
389 "description": "ResourceLoader sources to register"
393 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true.",
394 "additionalProperties": false,
398 "description": "Prefix for local paths to files in $options, relative to extenion directory"
402 "description": "Prefix for URLs to files in $options, relative to $wgExtensionAssetsPath"
406 "description": "Prefix for URLs to files in $options, relative to $wgStylePath"
409 "type": ["string", "array"],
410 "description": "Scripts to include (array of file paths)",
416 "type": ["string", "array"],
417 "description": "Modules which must be loaded before this module",
423 "type": ["string", "array", "object"],
424 "description": "Styles to load",
430 "type": ["string", "array"],
431 "description": "Messages to load",
440 "description": "Registry of factory functions to create Config objects"
442 "SessionProviders": {
444 "description": "Session providers"
446 "AuthManagerAutoConfig": {
448 "description": "AuthManager auto-configuration",
449 "additionalProperties": false,
453 "description": "Pre-authentication providers"
457 "description": "Primary authentication providers"
461 "description": "Secondary authentication providers"
465 "CentralIdLookupProviders": {
467 "description": "Central ID lookup providers"
469 "ChangeCredentialsBlacklist": {
471 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
473 "RemoveCredentialsBlacklist": {
475 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
479 "description": "Method to add extra namespaces",
511 "defaultcontentmodel": {
515 "type": ["string", "array"],
516 "description": "Userright(s) required to edit in this namespace"
518 "capitallinkoverride": {
520 "description": "Set $wgCapitalLinks on a per-namespace basis"
524 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
528 "required": ["id", "constant", "name"]
531 "TrackingCategories": {
533 "description": "Tracking category message keys",
538 "DefaultUserOptions": {
540 "description": "Default values of user options"
544 "description": "Preferences users cannot set",
549 "GroupPermissions": {
551 "description": "Default permissions to give to user groups",
552 "patternProperties": {
555 "patternProperties": {
563 "RevokePermissions": {
565 "description": "Default permissions to revoke from user groups",
566 "patternProperties": {
569 "patternProperties": {
577 "GrantPermissions": {
579 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
580 "patternProperties": {
583 "patternProperties": {
591 "GrantPermissionGroups": {
593 "description": "Map of grants to their UI grouping",
594 "patternProperties": {
602 "description": "Implicit groups"
606 "description": "Groups a user can add to themselves"
608 "GroupsRemoveFromSelf": {
610 "description": "Groups a user can remove from themselves"
614 "description": "Groups a user can add to users"
618 "description": "Groups a user can remove from users"
622 "description": "User rights added by the extension",
629 "description": "Mapping of model ID to class name",
630 "patternProperties": {
638 "description": "Rate limits"
640 "RecentChangesFlags": {
642 "description": "Flags (letter symbols) shown on RecentChanges pages"
646 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
648 "ExtensionFunctions": {
653 "description": "Function to call after setup has finished",
658 "ExtensionMessagesFiles": {
660 "description": "File paths containing PHP internationalization data"
664 "description": "Directory paths containing JSON internationalization data"
666 "ExtensionEntryPointListFiles": {
671 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
673 "AutoloadNamespaces": {
675 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
676 "patternProperties": {
677 "^[A-Za-z0-9\\\\]+\\\\$": {
681 "additionalProperties": false
687 "type": [ "string", "object" ],
688 "description": "Hooks this extension uses (mapping of hook name to callback)"
692 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
696 "description": "List of new log types this extension uses"
704 "ActionFilteredLogs": {
706 "description": "List of log types which can be filtered by log actions",
707 "patternProperties": {
710 "patternProperties": {
730 "LogActionsHandlers": {
739 "APIFormatModules": {
756 "description": "Available feeds objects"
760 "description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
764 "description": "Password policies"
768 "description": "Preferred file extensions for uploading",
775 "description": "Messages which are rendered as raw HTML",
780 "ReauthenticateTime": {
782 "patternProperties": {
793 "description": "A function to be called right after MediaWiki processes this file"
798 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
802 "description": "Configuration options for this extension",
803 "patternProperties": {
804 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
813 "array_merge_recursive",
814 "array_replace_recursive",
819 "default": "array_merge"
822 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
827 "type": ["string", "array"],
828 "description": "A description of the config setting, mostly for documentation/developers"
832 "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."
837 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
845 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
847 "ServiceWiringFiles": {
849 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
852 "description":"Registration information for other extensions",
854 "patternProperties": {
857 "patternProperties": {
859 "type": ["array", "object"]
865 "load_composer_autoloader": {
867 "description": "Load the composer autoloader for this extension, if one is present"