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."
82 "patternProperties": {
85 "description": "Required PHP extension.",
92 "description": "Set of version constraint strings against specific extensions."
96 "description": "Set of version constraint strings against specific skins."
100 "ResourceFileModulePaths": {
102 "description": "Default paths to use for all ResourceLoader file modules",
103 "additionalProperties": false,
107 "description": "Base path to prepend to all local paths, relative to current directory"
111 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
115 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
121 "description": "ResourceLoader modules to register",
122 "patternProperties": {
123 "^[a-zA-Z0-9-\\.]+$": {
127 "description": "A ResourceLoaderFileModule definition",
128 "additionalProperties": false,
132 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
136 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
140 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
144 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
147 "type": ["string", "array"],
148 "description": "Scripts to always include (array of file paths)",
155 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
156 "patternProperties": {
157 "^[a-zA-Z0-9-]{2,}$": {
170 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
171 "patternProperties": {
184 "type": ["string", "array"],
185 "description": "Scripts to include in debug contexts",
191 "type": ["string", "array"],
192 "description": "Scripts to include in the startup module",
198 "type": ["string", "array"],
199 "description": "Modules which must be loaded before this module",
205 "type": ["string", "array", "object"],
206 "description": "Styles to always load",
213 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
214 "patternProperties": {
227 "type": ["string", "array"],
228 "description": "Messages to always load",
235 "description": "Group with which this module should be loaded"
238 "type": ["object", "string", "boolean"],
239 "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."
243 "description": "Position on the page to load this module at",
250 "type": ["object", "array"],
251 "description": "Templates to be loaded for client-side usage"
254 "type": ["string", "array"],
255 "description": "ResourceLoader target the module can run on",
262 "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."
265 "type": ["object", "array"],
266 "description": "Package files that can be require()d"
271 "description": "A ResourceLoaderWikiModule definition",
272 "additionalProperties": false,
275 "enum": ["ResourceLoaderWikiModule"]
279 "description": "Group with which this module should be loaded"
283 "description": "Position on the page to load this module at",
290 "type": ["string", "array"],
291 "description": "ResourceLoader target the module can run on",
298 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
305 "description": "A list of on-wiki pages containing CSS that should be loaded",
313 "description": "A ResourceLoaderImageModule definition",
314 "additionalProperties": false,
317 "enum": ["ResourceLoaderImageModule"]
331 "selectorWithoutVariant": {
334 "selectorWithVariant": {
355 "description": "An arbitrary ResourceLoaderModule definition by class",
359 "pattern": "^(?!ResourceLoader(File|Image|Wiki)Module).*$"
362 "required": ["class"]
365 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
369 "description": "A static instantiator function for creating the ResourceLoaderModule object."
372 "required": ["factory"]
378 "ResourceModuleSkinStyles": {
380 "description": "ResourceLoader modules for custom skin styles"
382 "ResourceLoaderSources": {
384 "description": "ResourceLoader sources to register"
388 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true.",
389 "additionalProperties": false,
393 "description": "Prefix for local paths to files in $options, relative to extenion directory"
397 "description": "Prefix for URLs to files in $options, relative to $wgExtensionAssetsPath"
401 "description": "Prefix for URLs to files in $options, relative to $wgStylePath"
404 "type": ["string", "array"],
405 "description": "Scripts to include (array of file paths)",
411 "type": ["string", "array"],
412 "description": "Modules which must be loaded before this module",
418 "type": ["string", "array", "object"],
419 "description": "Styles to load",
425 "type": ["string", "array"],
426 "description": "Messages to load",
435 "description": "Registry of factory functions to create Config objects"
437 "SessionProviders": {
439 "description": "Session providers"
441 "AuthManagerAutoConfig": {
443 "description": "AuthManager auto-configuration",
444 "additionalProperties": false,
448 "description": "Pre-authentication providers"
452 "description": "Primary authentication providers"
456 "description": "Secondary authentication providers"
460 "CentralIdLookupProviders": {
462 "description": "Central ID lookup providers"
464 "ChangeCredentialsBlacklist": {
466 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
468 "RemoveCredentialsBlacklist": {
470 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
474 "description": "Method to add extra namespaces",
506 "defaultcontentmodel": {
510 "type": ["string", "array"],
511 "description": "Userright(s) required to edit in this namespace"
513 "capitallinkoverride": {
515 "description": "Set $wgCapitalLinks on a per-namespace basis"
519 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
523 "required": ["id", "constant", "name"]
526 "TrackingCategories": {
528 "description": "Tracking category message keys",
533 "DefaultUserOptions": {
535 "description": "Default values of user options"
539 "description": "Preferences users cannot set",
544 "GroupPermissions": {
546 "description": "Default permissions to give to user groups",
547 "patternProperties": {
550 "patternProperties": {
558 "RevokePermissions": {
560 "description": "Default permissions to revoke from user groups",
561 "patternProperties": {
564 "patternProperties": {
572 "GrantPermissions": {
574 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
575 "patternProperties": {
578 "patternProperties": {
586 "GrantPermissionGroups": {
588 "description": "Map of grants to their UI grouping",
589 "patternProperties": {
597 "description": "Implicit groups"
601 "description": "Groups a user can add to themselves"
603 "GroupsRemoveFromSelf": {
605 "description": "Groups a user can remove from themselves"
609 "description": "Groups a user can add to users"
613 "description": "Groups a user can remove from users"
617 "description": "User rights added by the extension",
624 "description": "Mapping of model ID to class name",
625 "patternProperties": {
633 "description": "Rate limits"
635 "RecentChangesFlags": {
637 "description": "Flags (letter symbols) shown on RecentChanges pages"
641 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
643 "ExtensionFunctions": {
648 "description": "Function to call after setup has finished",
653 "ExtensionMessagesFiles": {
655 "description": "File paths containing PHP internationalization data"
659 "description": "Directory paths containing JSON internationalization data"
661 "ExtensionEntryPointListFiles": {
666 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
668 "AutoloadNamespaces": {
670 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
671 "patternProperties": {
672 "^[A-Za-z0-9\\\\]+\\\\$": {
676 "additionalProperties": false
682 "type": [ "string", "object" ],
683 "description": "Hooks this extension uses (mapping of hook name to callback)"
687 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
691 "description": "List of new log types this extension uses"
699 "ActionFilteredLogs": {
701 "description": "List of log types which can be filtered by log actions",
702 "patternProperties": {
705 "patternProperties": {
725 "LogActionsHandlers": {
734 "APIFormatModules": {
751 "description": "Available feeds objects"
755 "description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
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"
793 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
797 "description": "Configuration options for this extension",
798 "patternProperties": {
799 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
808 "array_merge_recursive",
809 "array_replace_recursive",
814 "default": "array_merge"
817 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
822 "type": ["string", "array"],
823 "description": "A description of the config setting, mostly for documentation/developers"
827 "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."
832 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
840 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
842 "ServiceWiringFiles": {
844 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
847 "description":"Registration information for other extensions",
849 "patternProperties": {
852 "patternProperties": {
854 "type": ["array", "object"]
860 "load_composer_autoloader": {
862 "description": "Load the composer autoloader for this extension, if one is present"