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": "Required PHP extension.",
85 "description": "Set of version constraint strings against specific extensions."
89 "description": "Set of version constraint strings against specific skins."
93 "ResourceFileModulePaths": {
95 "description": "Default paths to use for all ResourceLoader file modules",
96 "additionalProperties": false,
100 "description": "Base path to prepend to all local paths, relative to current directory"
104 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
108 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
114 "description": "ResourceLoader modules to register",
115 "patternProperties": {
116 "^[a-zA-Z0-9-\\.]+$": {
120 "description": "A ResourceLoaderFileModule definition",
121 "additionalProperties": false,
125 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
129 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
133 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
137 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
140 "type": ["string", "array"],
141 "description": "Scripts to always include (array of file paths)",
148 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
149 "patternProperties": {
150 "^[a-zA-Z0-9-]{2,}$": {
163 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
164 "patternProperties": {
177 "type": ["string", "array"],
178 "description": "Scripts to include in debug contexts",
184 "type": ["string", "array"],
185 "description": "Scripts to include in the startup module",
191 "type": ["string", "array"],
192 "description": "Modules which must be loaded before this module",
198 "type": ["string", "array", "object"],
199 "description": "Styles to always load",
206 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
207 "patternProperties": {
220 "type": ["string", "array"],
221 "description": "Messages to always load",
228 "description": "Group which this module should be loaded together with"
231 "type": ["object", "string", "boolean"],
232 "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."
236 "description": "Position on the page to load this module at",
243 "type": ["object", "array"],
244 "description": "Templates to be loaded for client-side usage"
247 "type": ["string", "array"],
248 "description": "ResourceLoader target the module can run on",
255 "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."
260 "description": "A ResourceLoaderWikiModule definition",
261 "additionalProperties": false,
264 "enum": ["ResourceLoaderWikiModule"]
268 "description": "Group which this module should be loaded together with"
272 "description": "Position on the page to load this module at",
279 "type": ["string", "array"],
280 "description": "ResourceLoader target the module can run on",
300 "description": "A ResourceLoaderImageModule definition",
301 "additionalProperties": false,
304 "enum": ["ResourceLoaderImageModule"]
318 "selectorWithoutVariant": {
321 "selectorWithVariant": {
342 "description": "An arbitrary ResourceLoaderModule definition",
346 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
349 "required": ["class"]
355 "ResourceModuleSkinStyles": {
357 "description": "ResourceLoader modules for custom skin styles"
359 "ResourceLoaderSources": {
361 "description": "ResourceLoader sources to register"
365 "description": "Registry of factory functions to create Config objects"
367 "SessionProviders": {
369 "description": "Session providers"
371 "AuthManagerAutoConfig": {
373 "description": "AuthManager auto-configuration",
374 "additionalProperties": false,
378 "description": "Pre-authentication providers"
382 "description": "Primary authentication providers"
386 "description": "Secondary authentication providers"
390 "CentralIdLookupProviders": {
392 "description": "Central ID lookup providers"
396 "description": "Method to add extra namespaces",
428 "defaultcontentmodel": {
432 "type": ["string", "array"],
433 "description": "Userright(s) required to edit in this namespace"
435 "capitallinkoverride": {
437 "description": "Set $wgCapitalLinks on a per-namespace basis"
441 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
445 "required": ["id", "constant", "name"]
448 "TrackingCategories": {
450 "description": "Tracking category message keys",
455 "DefaultUserOptions": {
457 "description": "Default values of user options"
461 "description": "Preferences users cannot set",
466 "GroupPermissions": {
468 "description": "Default permissions to give to user groups",
469 "patternProperties": {
472 "patternProperties": {
480 "RevokePermissions": {
482 "description": "Default permissions to revoke from user groups",
483 "patternProperties": {
486 "patternProperties": {
494 "GrantPermissions": {
496 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
497 "patternProperties": {
500 "patternProperties": {
508 "GrantPermissionGroups": {
510 "description": "Map of grants to their UI grouping",
511 "patternProperties": {
519 "description": "Implicit groups"
523 "description": "Groups a user can add to themselves"
525 "GroupsRemoveFromSelf": {
527 "description": "Groups a user can remove from themselves"
531 "description": "Groups a user can add to users"
535 "description": "Groups a user can remove from users"
539 "description": "User rights added by the extension",
546 "description": "Mapping of model ID to class name",
547 "patternProperties": {
555 "description": "Rate limits"
557 "RecentChangesFlags": {
559 "description": "Flags (letter symbols) shown on RecentChanges pages"
563 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
565 "ExtensionFunctions": {
570 "description": "Function to call after setup has finished",
575 "ExtensionMessagesFiles": {
577 "description": "File paths containing PHP internationalization data"
581 "description": "Directory paths containing JSON internationalization data"
583 "ExtensionEntryPointListFiles": {
588 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
590 "AutoloadNamespaces": {
592 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
593 "patternProperties": {
594 "^[A-Za-z0-9\\\\]+\\\\$": {
598 "additionalProperties": false
604 "type": [ "string", "object" ],
605 "description": "Hooks this extension uses (mapping of hook name to callback)"
609 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
613 "description": "List of new log types this extension uses"
621 "ActionFilteredLogs": {
623 "description": "List of log types which can be filtered by log actions",
624 "patternProperties": {
627 "patternProperties": {
647 "LogActionsHandlers": {
656 "APIFormatModules": {
673 "description": "Available feeds objects"
680 "description": "Password policies"
684 "description": "Preferred file extensions for uploading",
691 "description": "Messages which are rendered as raw HTML",
701 "description": "A function to be called right after MediaWiki processes this file"
705 "description": "Configuration options for this extension",
710 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
713 "patternProperties": {
714 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
719 "array_merge_recursive",
720 "array_replace_recursive",
725 "default": "array_merge"
733 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
735 "ServiceWiringFiles": {
737 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
739 "load_composer_autoloader": {
741 "description": "Load the composer autoloader for this extension, if one is present"