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."
76 "patternProperties": {
79 "description": "Required PHP extension.",
86 "description": "Set of version constraint strings against specific extensions."
90 "description": "Set of version constraint strings against specific skins."
94 "ResourceFileModulePaths": {
96 "description": "Default paths to use for all ResourceLoader file modules",
97 "additionalProperties": false,
101 "description": "Base path to prepend to all local paths, relative to current directory"
105 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
109 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
115 "description": "ResourceLoader modules to register",
116 "patternProperties": {
117 "^[a-zA-Z0-9-\\.]+$": {
121 "description": "A ResourceLoaderFileModule definition",
122 "additionalProperties": false,
126 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
130 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
134 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
138 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
141 "type": ["string", "array"],
142 "description": "Scripts to always include (array of file paths)",
149 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
150 "patternProperties": {
151 "^[a-zA-Z0-9-]{2,}$": {
164 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
165 "patternProperties": {
178 "type": ["string", "array"],
179 "description": "Scripts to include in debug contexts",
185 "type": ["string", "array"],
186 "description": "Scripts to include in the startup module",
192 "type": ["string", "array"],
193 "description": "Modules which must be loaded before this module",
199 "type": ["string", "array", "object"],
200 "description": "Styles to always load",
207 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
208 "patternProperties": {
221 "type": ["string", "array"],
222 "description": "Messages to always load",
229 "description": "Group with which this module should be loaded"
232 "type": ["object", "string", "boolean"],
233 "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."
237 "description": "Position on the page to load this module at",
244 "type": ["object", "array"],
245 "description": "Templates to be loaded for client-side usage"
248 "type": ["string", "array"],
249 "description": "ResourceLoader target the module can run on",
256 "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."
259 "type": ["object", "array"],
260 "description": "Package files that can be require()d"
265 "description": "A ResourceLoaderWikiModule definition",
266 "additionalProperties": false,
269 "enum": ["ResourceLoaderWikiModule"]
273 "description": "Group with which this module should be loaded"
277 "description": "Position on the page to load this module at",
284 "type": ["string", "array"],
285 "description": "ResourceLoader target the module can run on",
292 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
299 "description": "A list of on-wiki pages containing CSS that should be loaded",
307 "description": "A ResourceLoaderImageModule definition",
308 "additionalProperties": false,
311 "enum": ["ResourceLoaderImageModule"]
325 "selectorWithoutVariant": {
328 "selectorWithVariant": {
349 "description": "An arbitrary ResourceLoaderModule definition by class",
353 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
356 "required": ["class"]
359 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
363 "description": "A static instantiator function for creating the ResourceLoaderModule object."
366 "required": ["factory"]
372 "ResourceModuleSkinStyles": {
374 "description": "ResourceLoader modules for custom skin styles"
376 "ResourceLoaderSources": {
378 "description": "ResourceLoader sources to register"
382 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true.",
383 "additionalProperties": false,
387 "description": "Prefix for local paths to files in $options, relative to extenion directory"
391 "description": "Prefix for URLs to files in $options, relative to $wgExtensionAssetsPath"
395 "description": "Prefix for URLs to files in $options, relative to $wgStylePath"
398 "type": ["string", "array"],
399 "description": "Scripts to include (array of file paths)",
405 "type": ["string", "array"],
406 "description": "Modules which must be loaded before this module",
412 "type": ["string", "array", "object"],
413 "description": "Styles to load",
419 "type": ["string", "array"],
420 "description": "Messages to load",
429 "description": "Registry of factory functions to create Config objects"
431 "SessionProviders": {
433 "description": "Session providers"
435 "AuthManagerAutoConfig": {
437 "description": "AuthManager auto-configuration",
438 "additionalProperties": false,
442 "description": "Pre-authentication providers"
446 "description": "Primary authentication providers"
450 "description": "Secondary authentication providers"
454 "CentralIdLookupProviders": {
456 "description": "Central ID lookup providers"
458 "ChangeCredentialsBlacklist": {
460 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
462 "RemoveCredentialsBlacklist": {
464 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
468 "description": "Method to add extra namespaces",
500 "defaultcontentmodel": {
504 "type": ["string", "array"],
505 "description": "Userright(s) required to edit in this namespace"
507 "capitallinkoverride": {
509 "description": "Set $wgCapitalLinks on a per-namespace basis"
513 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
517 "required": ["id", "constant", "name"]
520 "TrackingCategories": {
522 "description": "Tracking category message keys",
527 "DefaultUserOptions": {
529 "description": "Default values of user options"
533 "description": "Preferences users cannot set",
538 "GroupPermissions": {
540 "description": "Default permissions to give to user groups",
541 "patternProperties": {
544 "patternProperties": {
552 "RevokePermissions": {
554 "description": "Default permissions to revoke from user groups",
555 "patternProperties": {
558 "patternProperties": {
566 "GrantPermissions": {
568 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
569 "patternProperties": {
572 "patternProperties": {
580 "GrantPermissionGroups": {
582 "description": "Map of grants to their UI grouping",
583 "patternProperties": {
591 "description": "Implicit groups"
595 "description": "Groups a user can add to themselves"
597 "GroupsRemoveFromSelf": {
599 "description": "Groups a user can remove from themselves"
603 "description": "Groups a user can add to users"
607 "description": "Groups a user can remove from users"
611 "description": "User rights added by the extension",
618 "description": "Mapping of model ID to class name",
619 "patternProperties": {
627 "description": "Rate limits"
629 "RecentChangesFlags": {
631 "description": "Flags (letter symbols) shown on RecentChanges pages"
635 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
637 "ExtensionFunctions": {
642 "description": "Function to call after setup has finished",
647 "ExtensionMessagesFiles": {
649 "description": "File paths containing PHP internationalization data"
653 "description": "Directory paths containing JSON internationalization data"
655 "ExtensionEntryPointListFiles": {
660 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
662 "AutoloadNamespaces": {
664 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
665 "patternProperties": {
666 "^[A-Za-z0-9\\\\]+\\\\$": {
670 "additionalProperties": false
676 "type": [ "string", "object" ],
677 "description": "Hooks this extension uses (mapping of hook name to callback)"
681 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
685 "description": "List of new log types this extension uses"
693 "ActionFilteredLogs": {
695 "description": "List of log types which can be filtered by log actions",
696 "patternProperties": {
699 "patternProperties": {
719 "LogActionsHandlers": {
728 "APIFormatModules": {
745 "description": "Available feeds objects"
749 "description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
753 "description": "Password policies"
757 "description": "Preferred file extensions for uploading",
764 "description": "Messages which are rendered as raw HTML",
769 "ReauthenticateTime": {
771 "patternProperties": {
782 "description": "A function to be called right after MediaWiki processes this file"
787 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
791 "description": "Configuration options for this extension",
792 "patternProperties": {
793 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
802 "array_merge_recursive",
803 "array_replace_recursive",
808 "default": "array_merge"
811 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
816 "type": ["string", "array"],
817 "description": "A description of the config setting, mostly for documentation/developers"
821 "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."
826 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
834 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
836 "ServiceWiringFiles": {
838 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
841 "description":"Registration information for other extensions",
843 "patternProperties": {
846 "patternProperties": {
848 "type": ["array", "object"]
854 "load_composer_autoloader": {
856 "description": "Load the composer autoloader for this extension, if one is present"