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."
267 "description": "A ResourceLoaderWikiModule definition",
268 "additionalProperties": false,
271 "enum": ["ResourceLoaderWikiModule"]
275 "description": "Group with which this module should be loaded"
279 "description": "Position on the page to load this module at",
286 "type": ["string", "array"],
287 "description": "ResourceLoader target the module can run on",
294 "description": "A list of on-wiki pages containing JavaScript that should be loaded",
301 "description": "A list of on-wiki pages containing CSS that should be loaded",
309 "description": "A ResourceLoaderImageModule definition",
310 "additionalProperties": false,
313 "enum": ["ResourceLoaderImageModule"]
327 "selectorWithoutVariant": {
330 "selectorWithVariant": {
351 "description": "An arbitrary ResourceLoaderModule definition by class",
355 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
358 "required": ["class"]
361 "description": "An arbitrary ResourceLoaderModule definition with instantiator",
365 "description": "A static instantiator function for creating the ResourceLoaderModule object."
368 "required": ["factory"]
374 "ResourceModuleSkinStyles": {
376 "description": "ResourceLoader modules for custom skin styles"
378 "ResourceLoaderSources": {
380 "description": "ResourceLoader sources to register"
384 "description": "Registry of factory functions to create Config objects"
386 "SessionProviders": {
388 "description": "Session providers"
390 "AuthManagerAutoConfig": {
392 "description": "AuthManager auto-configuration",
393 "additionalProperties": false,
397 "description": "Pre-authentication providers"
401 "description": "Primary authentication providers"
405 "description": "Secondary authentication providers"
409 "CentralIdLookupProviders": {
411 "description": "Central ID lookup providers"
413 "ChangeCredentialsBlacklist": {
415 "description": "AuthenticationRequest classes which can only be used internally for credentials change"
417 "RemoveCredentialsBlacklist": {
419 "description": "AuthenticationRequest classes which can only be used internally for credentials removal"
423 "description": "Method to add extra namespaces",
455 "defaultcontentmodel": {
459 "type": ["string", "array"],
460 "description": "Userright(s) required to edit in this namespace"
462 "capitallinkoverride": {
464 "description": "Set $wgCapitalLinks on a per-namespace basis"
468 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
472 "required": ["id", "constant", "name"]
475 "TrackingCategories": {
477 "description": "Tracking category message keys",
482 "DefaultUserOptions": {
484 "description": "Default values of user options"
488 "description": "Preferences users cannot set",
493 "GroupPermissions": {
495 "description": "Default permissions to give to user groups",
496 "patternProperties": {
499 "patternProperties": {
507 "RevokePermissions": {
509 "description": "Default permissions to revoke from user groups",
510 "patternProperties": {
513 "patternProperties": {
521 "GrantPermissions": {
523 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
524 "patternProperties": {
527 "patternProperties": {
535 "GrantPermissionGroups": {
537 "description": "Map of grants to their UI grouping",
538 "patternProperties": {
546 "description": "Implicit groups"
550 "description": "Groups a user can add to themselves"
552 "GroupsRemoveFromSelf": {
554 "description": "Groups a user can remove from themselves"
558 "description": "Groups a user can add to users"
562 "description": "Groups a user can remove from users"
566 "description": "User rights added by the extension",
573 "description": "Mapping of model ID to class name",
574 "patternProperties": {
582 "description": "Rate limits"
584 "RecentChangesFlags": {
586 "description": "Flags (letter symbols) shown on RecentChanges pages"
590 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
592 "ExtensionFunctions": {
597 "description": "Function to call after setup has finished",
602 "ExtensionMessagesFiles": {
604 "description": "File paths containing PHP internationalization data"
608 "description": "Directory paths containing JSON internationalization data"
610 "ExtensionEntryPointListFiles": {
615 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
617 "AutoloadNamespaces": {
619 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
620 "patternProperties": {
621 "^[A-Za-z0-9\\\\]+\\\\$": {
625 "additionalProperties": false
631 "type": [ "string", "object" ],
632 "description": "Hooks this extension uses (mapping of hook name to callback)"
636 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
640 "description": "List of new log types this extension uses"
648 "ActionFilteredLogs": {
650 "description": "List of log types which can be filtered by log actions",
651 "patternProperties": {
654 "patternProperties": {
674 "LogActionsHandlers": {
683 "APIFormatModules": {
700 "description": "Available feeds objects"
704 "description": "Map of skin names to OOUI themes to use. Same format as ResourceLoaderOOUIModule::$builtinSkinThemeMap."
708 "description": "Password policies"
712 "description": "Preferred file extensions for uploading",
719 "description": "Messages which are rendered as raw HTML",
724 "ReauthenticateTime": {
726 "patternProperties": {
737 "description": "A function to be called right after MediaWiki processes this file"
742 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
746 "description": "Configuration options for this extension",
747 "patternProperties": {
748 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
757 "array_merge_recursive",
758 "array_replace_recursive",
763 "default": "array_merge"
766 "description": "Whether this should be interpreted as a filesystem path, relative to extension directory root",
771 "type": ["string", "array"],
772 "description": "A description of the config setting, mostly for documentation/developers"
776 "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."
781 "description": "Whether this configuration option and its value is allowed to be revealed in public or not."
789 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
791 "ServiceWiringFiles": {
793 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
796 "description":"Registration information for other extensions",
798 "patternProperties": {
801 "patternProperties": {
803 "type": ["array", "object"]
809 "load_composer_autoloader": {
811 "description": "Load the composer autoloader for this extension, if one is present"