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.",
46 "description": "Raw description of the extension."
50 "description": "Message key for a i18n message describing the extension."
54 "description": "Short identifier for the license under which the extension is released.",
80 "BSD-2-Clause-FreeBSD",
81 "BSD-2-Clause-NetBSD",
93 "CNRI-Python-GPL-Compatible",
152 "GPL-2.0-with-autoconf-exception",
153 "GPL-2.0-with-bison-exception",
154 "GPL-2.0-with-classpath-exception",
155 "GPL-2.0-with-font-exception",
156 "GPL-2.0-with-GCC-exception",
159 "GPL-3.0-with-autoconf-exception",
160 "GPL-3.0-with-GCC-exception",
193 "MPL-2.0-no-copyleft-exception",
275 "description": "Indicates what versions of MediaWiki core are required. This syntax may be extended in the future, for example to check dependencies between other extensions.",
279 "description": "Version constraint string against MediaWiki core."
283 "ResourceFileModulePaths": {
285 "description": "Default paths to use for all ResourceLoader file modules",
286 "additionalProperties": false,
290 "description": "Base path to prepend to all local paths, relative to current directory"
294 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
298 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
304 "description": "ResourceLoader modules to register",
305 "patternProperties": {
306 "^[a-zA-Z0-9-\\.]+$": {
310 "description": "A ResourceLoaderFileModule definition",
311 "additionalProperties": false,
315 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
319 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
323 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
327 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
330 "type": ["string", "array"],
331 "description": "Scripts to always include (array of file paths)",
338 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
339 "patternProperties": {
340 "^[a-zA-Z0-9-]{2,}$": {
353 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
354 "patternProperties": {
367 "type": ["string", "array"],
368 "description": "Scripts to include in debug contexts",
374 "type": ["string", "array"],
375 "description": "Scripts to include in the startup module",
381 "type": ["string", "array"],
382 "description": "Modules which must be loaded before this module",
388 "type": ["string", "array", "object"],
389 "description": "Styles to always load",
396 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
397 "patternProperties": {
410 "type": ["string", "array"],
411 "description": "Messages to always load",
418 "description": "Group with which this module should be loaded"
422 "description": "Position on the page to load this module at",
429 "type": ["object", "array"],
430 "description": "Templates to be loaded for client-side usage"
433 "type": ["string", "array"],
434 "description": "ResourceLoader target the module can run on",
442 "description": "A ResourceLoaderWikiModule definition",
443 "additionalProperties": false,
446 "enum": ["ResourceLoaderWikiModule"]
450 "description": "Group with which this module should be loaded"
454 "description": "Position on the page to load this module at",
461 "type": ["string", "array"],
462 "description": "ResourceLoader target the module can run on",
469 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
476 "description": "A list of on-wiki pages containing CSS that should be loaded",
484 "description": "A ResourceLoaderImageModule definition",
485 "additionalProperties": false,
488 "enum": ["ResourceLoaderImageModule"]
499 "selectorWithoutVariant": {
502 "selectorWithVariant": {
520 "description": "An arbitrary ResourceLoaderModule definition",
524 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
527 "required": ["class"]
533 "ResourceModuleSkinStyles": {
535 "description": "ResourceLoader modules for custom skin styles"
537 "ResourceLoaderSources": {
539 "description": "ResourceLoader sources to register"
541 "ResourceLoaderLESSVars": {
543 "description": "ResourceLoader LESS variables"
547 "description": "Registry of factory functions to create Config objects"
549 "SessionProviders": {
551 "description": "Session providers"
553 "AuthManagerAutoConfig": {
555 "description": "AuthManager auto-configuration",
556 "additionalProperties": false,
560 "description": "Pre-authentication providers"
564 "description": "Primary authentication providers"
568 "description": "Secondary authentication providers"
572 "CentralIdLookupProviders": {
574 "description": "Central ID lookup providers"
576 "ChangeCredentialsBlacklist": {
578 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
580 "RemoveCredentialsBlacklist": {
582 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
586 "description": "Method to add extra namespaces",
618 "defaultcontentmodel": {
622 "type": ["string", "array"],
623 "description": "Userright(s) required to edit in this namespace"
625 "capitallinkoverride": {
627 "description": "Set $wgCapitalLinks on a per-namespace basis"
631 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
635 "required": ["id", "constant", "name"]
638 "TrackingCategories": {
640 "description": "Tracking category message keys",
645 "DefaultUserOptions": {
647 "description": "Default values of user options"
651 "description": "Preferences users cannot set",
656 "GroupPermissions": {
658 "description": "Default permissions to give to user groups",
659 "patternProperties": {
662 "patternProperties": {
670 "RevokePermissions": {
672 "description": "Default permissions to revoke from user groups",
673 "patternProperties": {
676 "patternProperties": {
684 "GrantPermissions": {
686 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
687 "patternProperties": {
690 "patternProperties": {
698 "GrantPermissionGroups": {
700 "description": "Map of grants to their UI grouping",
701 "patternProperties": {
709 "description": "Implicit groups"
713 "description": "Groups a user can add to themselves"
715 "GroupsRemoveFromSelf": {
717 "description": "Groups a user can remove from themselves"
721 "description": "Groups a user can add to users"
725 "description": "Groups a user can remove from users"
729 "description": "User rights added by the extension",
736 "description": "Mapping of model ID to class name",
737 "patternProperties": {
745 "description": "Rate limits"
747 "RecentChangesFlags": {
749 "description": "Flags (letter symbols) shown on RecentChanges pages"
753 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
755 "ExtensionFunctions": {
760 "description": "Function to call after setup has finished",
765 "ExtensionMessagesFiles": {
767 "description": "File paths containing PHP internationalization data"
771 "description": "Directory paths containing JSON internationalization data"
773 "ExtensionEntryPointListFiles": {
778 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
784 "type": [ "string", "object" ],
785 "description": "Hooks this extension uses (mapping of hook name to callback)"
789 "description": "Job types this extension implements (mapping of job type to class name)"
793 "description": "List of new log types this extension uses"
801 "ActionFilteredLogs": {
803 "description": "List of log types which can be filtered by log actions",
804 "patternProperties": {
807 "patternProperties": {
827 "LogActionsHandlers": {
836 "APIFormatModules": {
853 "description": "Available feeds objects"
863 "description": "A function to be called right after MediaWiki processes this file"
868 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
872 "description": "Configuration options for this extension",
873 "patternProperties": {
874 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
883 "array_merge_recursive",
888 "default": "array_merge"
891 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
896 "type": ["string", "array"],
897 "description": "A description of the config setting, mostly for documentation/developers"
905 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
907 "load_composer_autoloader": {
909 "description": "Load the composer autoloader for this extension, if one is present"