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."
261 "description": "A ResourceLoaderWikiModule definition",
262 "additionalProperties": false,
265 "enum": ["ResourceLoaderWikiModule"]
269 "description": "Group with which this module should be loaded"
273 "description": "Position on the page to load this module at",
280 "type": ["string", "array"],
281 "description": "ResourceLoader target the module can run on",
288 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
295 "description": "A list of on-wiki pages containing CSS that should be loaded",
303 "description": "A ResourceLoaderImageModule definition",
304 "additionalProperties": false,
307 "enum": ["ResourceLoaderImageModule"]
321 "selectorWithoutVariant": {
324 "selectorWithVariant": {
345 "description": "An arbitrary ResourceLoaderModule definition by class",
349 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
352 "required": ["class"]
355 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
359 "description": "A static instantiator function for creating the ResourceLoaderModule object."
362 "required": ["factory"]
368 "ResourceModuleSkinStyles": {
370 "description": "ResourceLoader modules for custom skin styles"
372 "ResourceLoaderSources": {
374 "description": "ResourceLoader sources to register"
378 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true.",
379 "additionalProperties": false,
383 "description": "Prefix for local paths to files in $options, relative to extenion directory"
387 "description": "Prefix for URLs to files in $options, relative to $wgExtensionAssetsPath"
391 "description": "Prefix for URLs to files in $options, relative to $wgStylePath"
394 "type": ["string", "array"],
395 "description": "Scripts to include (array of file paths)",
401 "type": ["string", "array"],
402 "description": "Modules which must be loaded before this module",
408 "type": ["string", "array", "object"],
409 "description": "Styles to load",
415 "type": ["string", "array"],
416 "description": "Messages to load",
425 "description": "Registry of factory functions to create Config objects"
427 "SessionProviders": {
429 "description": "Session providers"
431 "AuthManagerAutoConfig": {
433 "description": "AuthManager auto-configuration",
434 "additionalProperties": false,
438 "description": "Pre-authentication providers"
442 "description": "Primary authentication providers"
446 "description": "Secondary authentication providers"
450 "CentralIdLookupProviders": {
452 "description": "Central ID lookup providers"
454 "ChangeCredentialsBlacklist": {
456 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
458 "RemoveCredentialsBlacklist": {
460 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
464 "description": "Method to add extra namespaces",
496 "defaultcontentmodel": {
500 "type": ["string", "array"],
501 "description": "Userright(s) required to edit in this namespace"
503 "capitallinkoverride": {
505 "description": "Set $wgCapitalLinks on a per-namespace basis"
509 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
513 "required": ["id", "constant", "name"]
516 "TrackingCategories": {
518 "description": "Tracking category message keys",
523 "DefaultUserOptions": {
525 "description": "Default values of user options"
529 "description": "Preferences users cannot set",
534 "GroupPermissions": {
536 "description": "Default permissions to give to user groups",
537 "patternProperties": {
540 "patternProperties": {
548 "RevokePermissions": {
550 "description": "Default permissions to revoke from user groups",
551 "patternProperties": {
554 "patternProperties": {
562 "GrantPermissions": {
564 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
565 "patternProperties": {
568 "patternProperties": {
576 "GrantPermissionGroups": {
578 "description": "Map of grants to their UI grouping",
579 "patternProperties": {
587 "description": "Implicit groups"
591 "description": "Groups a user can add to themselves"
593 "GroupsRemoveFromSelf": {
595 "description": "Groups a user can remove from themselves"
599 "description": "Groups a user can add to users"
603 "description": "Groups a user can remove from users"
607 "description": "User rights added by the extension",
614 "description": "Mapping of model ID to class name",
615 "patternProperties": {
623 "description": "Rate limits"
625 "RecentChangesFlags": {
627 "description": "Flags (letter symbols) shown on RecentChanges pages"
631 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
633 "ExtensionFunctions": {
638 "description": "Function to call after setup has finished",
643 "ExtensionMessagesFiles": {
645 "description": "File paths containing PHP internationalization data"
649 "description": "Directory paths containing JSON internationalization data"
651 "ExtensionEntryPointListFiles": {
656 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
658 "AutoloadNamespaces": {
660 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
661 "patternProperties": {
662 "^[A-Za-z0-9\\\\]+\\\\$": {
666 "additionalProperties": false
672 "type": [ "string", "object" ],
673 "description": "Hooks this extension uses (mapping of hook name to callback)"
677 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
681 "description": "List of new log types this extension uses"
689 "ActionFilteredLogs": {
691 "description": "List of log types which can be filtered by log actions",
692 "patternProperties": {
695 "patternProperties": {
715 "LogActionsHandlers": {
724 "APIFormatModules": {
741 "description": "Available feeds objects"
745 "description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
749 "description": "Password policies"
753 "description": "Preferred file extensions for uploading",
760 "description": "Messages which are rendered as raw HTML",
765 "ReauthenticateTime": {
767 "patternProperties": {
778 "description": "A function to be called right after MediaWiki processes this file"
783 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
787 "description": "Configuration options for this extension",
788 "patternProperties": {
789 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
798 "array_merge_recursive",
799 "array_replace_recursive",
804 "default": "array_merge"
807 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
812 "type": ["string", "array"],
813 "description": "A description of the config setting, mostly for documentation/developers"
817 "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."
822 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
830 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
832 "ServiceWiringFiles": {
834 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
837 "description":"Registration information for other extensions",
839 "patternProperties": {
842 "patternProperties": {
844 "type": ["array", "object"]
850 "load_composer_autoloader": {
852 "description": "Load the composer autoloader for this extension, if one is present"