| blob | 1fccf17d28cb7a96fc5d50801ff546a7a943796c |
1 {
2 "$schema": "http://json-schema.org/schema#",
3 "description": "MediaWiki extension.json schema",
4 "type": "object",
5 "properties": {
6 "manifest_version": {
7 "type": "integer",
8 "description": "Version of the extension.json schema the extension.json file is in.",
9 "required": true
10 },
11 "name": {
12 "type": "string",
13 "description": "The extension's canonical name.",
14 "required": true
15 },
16 "namemsg": {
17 "type": "string",
18 "description": "i18n message key of the extension's name."
19 },
20 "type": {
21 "type": "string",
22 "description": "The extension's type, as an index to $wgExtensionCredits.",
23 "default": "other"
24 },
25 "author": {
26 "type": [
27 "string",
28 "array"
29 ],
30 "description": "Extension's authors.",
31 "items": {
32 "type": "string"
33 }
34 },
35 "version": {
36 "type": "string",
37 "description": "The version of this release of the extension."
38 },
39 "url": {
40 "type": "string",
41 "description": "URL to the homepage for the extension.",
42 "format": "uri"
43 },
44 "description": {
45 "type": "string",
46 "description": "Raw description of the extension."
47 },
48 "descriptionmsg": {
49 "type": "string",
50 "description": "Message key for a i18n message describing the extension."
51 },
52 "license-name": {
53 "type": "string",
54 "description": "Short identifier for the license under which the extension is released.",
55 "enum": [
56 "AFL-1.1",
57 "AFL-1.2",
58 "AFL-2.0",
59 "AFL-2.1",
60 "AFL-3.0",
61 "APL-1.0",
62 "Aladdin",
63 "ANTLR-PD",
64 "Apache-1.0",
65 "Apache-1.1",
66 "Apache-2.0",
67 "APSL-1.0",
68 "APSL-1.1",
69 "APSL-1.2",
70 "APSL-2.0",
71 "Artistic-1.0",
72 "Artistic-1.0-cl8",
73 "Artistic-1.0-Perl",
74 "Artistic-2.0",
75 "AAL",
76 "BitTorrent-1.0",
77 "BitTorrent-1.1",
78 "BSL-1.0",
79 "BSD-2-Clause",
80 "BSD-2-Clause-FreeBSD",
81 "BSD-2-Clause-NetBSD",
82 "BSD-3-Clause",
83 "BSD-3-Clause-Clear",
84 "BSD-4-Clause",
85 "BSD-4-Clause-UC",
86 "CECILL-1.0",
87 "CECILL-1.1",
88 "CECILL-2.0",
89 "CECILL-B",
90 "CECILL-C",
91 "ClArtistic",
92 "CNRI-Python",
93 "CNRI-Python-GPL-Compatible",
94 "CPOL-1.02",
95 "CDDL-1.0",
96 "CDDL-1.1",
97 "CPAL-1.0",
98 "CPL-1.0",
99 "CATOSL-1.1",
100 "Condor-1.1",
101 "CC-BY-1.0",
102 "CC-BY-2.0",
103 "CC-BY-2.5",
104 "CC-BY-3.0",
105 "CC-BY-ND-1.0",
106 "CC-BY-ND-2.0",
107 "CC-BY-ND-2.5",
108 "CC-BY-ND-3.0",
109 "CC-BY-NC-1.0",
110 "CC-BY-NC-2.0",
111 "CC-BY-NC-2.5",
112 "CC-BY-NC-3.0",
113 "CC-BY-NC-ND-1.0",
114 "CC-BY-NC-ND-2.0",
115 "CC-BY-NC-ND-2.5",
116 "CC-BY-NC-ND-3.0",
117 "CC-BY-NC-SA-1.0",
118 "CC-BY-NC-SA-2.0",
119 "CC-BY-NC-SA-2.5",
120 "CC-BY-NC-SA-3.0",
121 "CC-BY-SA-1.0",
122 "CC-BY-SA-2.0",
123 "CC-BY-SA-2.5",
124 "CC-BY-SA-3.0",
125 "CC0-1.0",
126 "CUA-OPL-1.0",
127 "D-FSL-1.0",
128 "WTFPL",
129 "EPL-1.0",
130 "eCos-2.0",
131 "ECL-1.0",
132 "ECL-2.0",
133 "EFL-1.0",
134 "EFL-2.0",
135 "Entessa",
136 "ErlPL-1.1",
137 "EUDatagrid",
138 "EUPL-1.0",
139 "EUPL-1.1",
140 "Fair",
141 "Frameworx-1.0",
142 "FTL",
143 "AGPL-1.0",
144 "AGPL-3.0",
145 "GFDL-1.1",
146 "GFDL-1.2",
147 "GFDL-1.3",
148 "GPL-1.0",
149 "GPL-1.0+",
150 "GPL-2.0",
151 "GPL-2.0+",
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",
157 "GPL-3.0",
158 "GPL-3.0+",
159 "GPL-3.0-with-autoconf-exception",
160 "GPL-3.0-with-GCC-exception",
161 "LGPL-2.1",
162 "LGPL-2.1+",
163 "LGPL-3.0",
164 "LGPL-3.0+",
165 "LGPL-2.0",
166 "LGPL-2.0+",
167 "gSOAP-1.3b",
168 "HPND",
169 "IBM-pibs",
170 "IPL-1.0",
171 "Imlib2",
172 "IJG",
173 "Intel",
174 "IPA",
175 "ISC",
176 "JSON",
177 "LPPL-1.3a",
178 "LPPL-1.0",
179 "LPPL-1.1",
180 "LPPL-1.2",
181 "LPPL-1.3c",
182 "Libpng",
183 "LPL-1.02",
184 "LPL-1.0",
185 "MS-PL",
186 "MS-RL",
187 "MirOS",
188 "MIT",
189 "Motosoto",
190 "MPL-1.0",
191 "MPL-1.1",
192 "MPL-2.0",
193 "MPL-2.0-no-copyleft-exception",
194 "Multics",
195 "NASA-1.3",
196 "Naumen",
197 "NBPL-1.0",
198 "NGPL",
199 "NOSL",
200 "NPL-1.0",
201 "NPL-1.1",
202 "Nokia",
203 "NPOSL-3.0",
204 "NTP",
205 "OCLC-2.0",
206 "ODbL-1.0",
207 "PDDL-1.0",
208 "OGTSL",
209 "OLDAP-2.2.2",
210 "OLDAP-1.1",
211 "OLDAP-1.2",
212 "OLDAP-1.3",
213 "OLDAP-1.4",
214 "OLDAP-2.0",
215 "OLDAP-2.0.1",
216 "OLDAP-2.1",
217 "OLDAP-2.2",
218 "OLDAP-2.2.1",
219 "OLDAP-2.3",
220 "OLDAP-2.4",
221 "OLDAP-2.5",
222 "OLDAP-2.6",
223 "OLDAP-2.7",
224 "OPL-1.0",
225 "OSL-1.0",
226 "OSL-2.0",
227 "OSL-2.1",
228 "OSL-3.0",
229 "OLDAP-2.8",
230 "OpenSSL",
231 "PHP-3.0",
232 "PHP-3.01",
233 "PostgreSQL",
234 "Python-2.0",
235 "QPL-1.0",
236 "RPSL-1.0",
237 "RPL-1.1",
238 "RPL-1.5",
239 "RHeCos-1.1",
240 "RSCPL",
241 "Ruby",
242 "SAX-PD",
243 "SGI-B-1.0",
244 "SGI-B-1.1",
245 "SGI-B-2.0",
246 "OFL-1.0",
247 "OFL-1.1",
248 "SimPL-2.0",
249 "Sleepycat",
250 "SMLNJ",
251 "SugarCRM-1.1.3",
252 "SISSL",
253 "SISSL-1.2",
254 "SPL-1.0",
255 "Watcom-1.0",
256 "NCSA",
257 "VSL-1.0",
258 "W3C",
259 "WXwindows",
260 "Xnet",
261 "X11",
262 "XFree86-1.1",
263 "YPL-1.0",
264 "YPL-1.1",
265 "Zimbra-1.3",
266 "Zlib",
267 "ZPL-1.1",
268 "ZPL-2.0",
269 "ZPL-2.1",
270 "Unlicense"
271 ]
272 },
273 "requires": {
274 "type": "object",
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.",
276 "properties": {
277 "MediaWiki": {
278 "type": "string",
279 "description": "Version constraint string against MediaWiki core."
280 }
281 }
282 },
283 "ResourceFileModulePaths": {
284 "type": "object",
285 "description": "Default paths to use for all ResourceLoader file modules",
286 "additionalProperties": false,
287 "properties": {
288 "localBasePath": {
289 "type": "string",
290 "description": "Base path to prepend to all local paths, relative to current directory"
291 },
292 "remoteExtPath": {
293 "type": "string",
294 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
295 },
296 "remoteSkinPath": {
297 "type": "string",
298 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
299 }
300 }
301 },
302 "ResourceModules": {
303 "type": "object",
304 "description": "ResourceLoader modules to register",
305 "patternProperties": {
306 "^[a-zA-Z0-9-\\.]+$": {
307 "type": "object",
308 "anyOf": [
309 {
310 "description": "A ResourceLoaderFileModule definition",
311 "additionalProperties": false,
312 "properties": {
313 "localBasePath": {
314 "type": "string",
315 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
316 },
317 "remoteBasePath": {
318 "type": "string",
319 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
320 },
321 "remoteExtPath": {
322 "type": "string",
323 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
324 },
325 "skipFunction": {
326 "type": "string",
327 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
328 },
329 "scripts": {
330 "type": ["string", "array"],
331 "description": "Scripts to always include (array of file paths)",
332 "items": {
333 "type": "string"
334 }
335 },
336 "languageScripts": {
337 "type": "object",
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,}$": {
341 "type": [
342 "string",
343 "array"
344 ],
345 "items": {
346 "type": "string"
347 }
348 }
349 }
350 },
351 "skinScripts": {
352 "type": "object",
353 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
354 "patternProperties": {
355 ".+": {
356 "type": [
357 "string",
358 "array"
359 ],
360 "items": {
361 "type": "string"
362 }
363 }
364 }
365 },
366 "debugScripts": {
367 "type": ["string", "array"],
368 "description": "Scripts to include in debug contexts",
369 "items": {
370 "type": "string"
371 }
372 },
373 "loaderScripts": {
374 "type": ["string", "array"],
375 "description": "Scripts to include in the startup module",
376 "items": {
377 "type": "string"
378 }
379 },
380 "dependencies": {
381 "type": ["string", "array"],
382 "description": "Modules which must be loaded before this module",
383 "items": {
384 "type": "string"
385 }
386 },
387 "styles": {
388 "type": ["string", "array", "object"],
389 "description": "Styles to always load",
390 "items": {
391 "type": "string"
392 }
393 },
394 "skinStyles": {
395 "type": "object",
396 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
397 "patternProperties": {
398 ".+": {
399 "type": [
400 "string",
401 "array"
402 ],
403 "items": {
404 "type": "string"
405 }
406 }
407 }
408 },
409 "messages": {
410 "type": ["string", "array"],
411 "description": "Messages to always load",
412 "items": {
413 "type": "string"
414 }
415 },
416 "group": {
417 "type": "string",
418 "description": "Group which this module should be loaded together with"
419 },
420 "position": {
421 "type": "string",
422 "description": "Position on the page to load this module at",
423 "enum": [
424 "bottom",
425 "top"
426 ]
427 },
428 "templates": {
429 "type": ["object", "array"],
430 "description": "Templates to be loaded for client-side usage"
431 },
432 "targets": {
433 "type": ["string", "array"],
434 "description": "ResourceLoader target the module can run on",
435 "items": {
436 "type": "string"
437 }
438 }
439 }
440 },
441 {
442 "description": "A ResourceLoaderImageModule definition",
443 "additionalProperties": false,
444 "properties": {
445 "class": {
446 "enum": ["ResourceLoaderImageModule"]
447 },
448 "data": {
449 "type": "string"
450 },
451 "prefix": {
452 "type": "string"
453 },
454 "selector": {
455 "type": "string"
456 },
457 "selectorWithoutVariant": {
458 "type": "string"
459 },
460 "selectorWithVariant": {
461 "type": "string"
462 },
463 "variants": {
464 "type": "object"
465 },
466 "images": {
467 "type": "object"
468 },
469 "position": {
470 "enum": [
471 "top",
472 "bottom"
473 ]
474 }
475 }
476 },
477 {
478 "description": "An arbitrary ResourceLoaderModule definition",
479 "properties": {
480 "class": {
481 "type": "string",
482 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
483 }
484 },
485 "required": ["class"]
486 }
487 ]
488 }
489 }
490 },
491 "ResourceModuleSkinStyles": {
492 "type": "object",
493 "description": "ResourceLoader modules for custom skin styles"
494 },
495 "ResourceLoaderSources": {
496 "type": "object",
497 "description": "ResourceLoader sources to register"
498 },
499 "ResourceLoaderLESSVars": {
500 "type": "object",
501 "description": "ResourceLoader LESS variables"
502 },
503 "ResourceLoaderLESSImportPaths": {
504 "type": "object",
505 "description": "ResourceLoader import paths"
506 },
507 "ConfigRegistry": {
508 "type": "object",
509 "description": "Registry of factory functions to create Config objects"
510 },
511 "SessionProviders": {
512 "type": "object",
513 "description": "Session providers"
514 },
515 "AuthManagerAutoConfig": {
516 "type": "object",
517 "description": "AuthManager auto-configuration",
518 "additionalProperties": false,
519 "properties": {
520 "preauth": {
521 "type": "object",
522 "description": "Pre-authentication providers"
523 },
524 "primaryauth": {
525 "type": "object",
526 "description": "Primary authentication providers"
527 },
528 "secondaryauth": {
529 "type": "object",
530 "description": "Secondary authentication providers"
531 }
532 }
533 },
534 "CentralIdLookupProviders": {
535 "type": "object",
536 "description": "Central ID lookup providers"
537 },
538 "namespaces": {
539 "type": "array",
540 "description": "Method to add extra namespaces",
541 "items": {
542 "type": "object",
543 "properties": {
544 "id": {
545 "type": "integer"
546 },
547 "constant": {
548 "type": "string"
549 },
550 "name": {
551 "type": "string"
552 },
553 "gender": {
554 "type": "object",
555 "properties": {
556 "male": {
557 "type": "string"
558 },
559 "female": {
560 "type": "string"
561 }
562 }
563 },
564 "subpages": {
565 "type": "boolean",
566 "default": false
567 },
568 "content": {
569 "type": "boolean",
570 "default": false
571 },
572 "defaultcontentmodel": {
573 "type": "string"
574 },
575 "protection": {
576 "type": ["string", "array"],
577 "description": "Userright(s) required to edit in this namespace"
578 },
579 "capitallinkoverride": {
580 "type": "boolean",
581 "description": "Set $wgCapitalLinks on a per-namespace basis"
582 }
583 },
584 "required": ["id", "constant", "name"]
585 }
586 },
587 "TrackingCategories": {
588 "type": "array",
589 "description": "Tracking category message keys",
590 "items": {
591 "type": "string"
592 }
593 },
594 "DefaultUserOptions": {
595 "type": "object",
596 "description": "Default values of user options"
597 },
598 "HiddenPrefs": {
599 "type": "array",
600 "description": "Preferences users cannot set",
601 "items": {
602 "type": "string"
603 }
604 },
605 "GroupPermissions": {
606 "type": "object",
607 "description": "Default permissions to give to user groups",
608 "patternProperties": {
609 "^[a-z]+$": {
610 "type": "object",
611 "patternProperties": {
612 "^[a-z]+$": {
613 "type": "boolean"
614 }
615 }
616 }
617 }
618 },
619 "RevokePermissions": {
620 "type": "object",
621 "description": "Default permissions to revoke from user groups",
622 "patternProperties": {
623 "^[a-z]+$": {
624 "type": "object",
625 "patternProperties": {
626 "^[a-z]+$": {
627 "type": "boolean"
628 }
629 }
630 }
631 }
632 },
633 "GrantPermissions": {
634 "type": "object",
635 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
636 "patternProperties": {
637 "^[a-z]+$": {
638 "type": "object",
639 "patternProperties": {
640 "^[a-z]+$": {
641 "type": "boolean"
642 }
643 }
644 }
645 }
646 },
647 "GrantPermissionGroups": {
648 "type": "object",
649 "description": "Map of grants to their UI grouping",
650 "patternProperties": {
651 "^[a-z]+$": {
652 "type": "string"
653 }
654 }
655 },
656 "ImplicitGroups": {
657 "type": "array",
658 "description": "Implicit groups"
659 },
660 "GroupsAddToSelf": {
661 "type": "object",
662 "description": "Groups a user can add to themselves"
663 },
664 "GroupsRemoveFromSelf": {
665 "type": "object",
666 "description": "Groups a user can remove from themselves"
667 },
668 "AddGroups": {
669 "type": "object",
670 "description": "Groups a user can add to users"
671 },
672 "RemoveGroups": {
673 "type": "object",
674 "description": "Groups a user can remove from users"
675 },
676 "AvailableRights": {
677 "type": "array",
678 "description": "User rights added by the extension",
679 "items": {
680 "type": "string"
681 }
682 },
683 "ContentHandlers": {
684 "type": "object",
685 "description": "Mapping of model ID to class name",
686 "patternProperties": {
687 "^[A-Za-z]+$": {
688 "type": "string"
689 }
690 }
691 },
692 "RateLimits": {
693 "type": "object",
694 "description": "Rate limits"
695 },
696 "RecentChangesFlags": {
697 "type": "object",
698 "description": "Flags (letter symbols) shown on RecentChanges pages"
699 },
700 "MediaHandlers": {
701 "type": "object",
702 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
703 },
704 "ExtensionFunctions": {
705 "type": [
706 "array",
707 "string"
708 ],
709 "description": "Function to call after setup has finished",
710 "items": {
711 "type": "string"
712 }
713 },
714 "ExtensionMessagesFiles": {
715 "type": "object",
716 "description": "File paths containing PHP internationalization data"
717 },
718 "MessagesDirs": {
719 "type": "object",
720 "description": "Directory paths containing JSON internationalization data"
721 },
722 "ExtensionEntryPointListFiles": {
723 "type": "object"
724 },
725 "SpecialPages": {
726 "type": "object",
727 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
728 },
729 "AutoloadClasses": {
730 "type": "object"
731 },
732 "Hooks": {
733 "type": [ "string", "object" ],
734 "description": "Hooks this extension uses (mapping of hook name to callback)"
735 },
736 "JobClasses": {
737 "type": "object",
738 "description": "Job types this extension implements (mapping of job type to class name)"
739 },
740 "LogTypes": {
741 "type": "array",
742 "description": "List of new log types this extension uses"
743 },
744 "LogRestrictions": {
745 "type": "object"
746 },
747 "FilterLogTypes": {
748 "type": "object"
749 },
750 "ActionFilteredLogs": {
751 "type": "object",
752 "description": "List of log types which can be filtered by log actions",
753 "patternProperties": {
754 "^[a-z-]+$": {
755 "type": "object",
756 "patternProperties": {
757 "^[a-z-]+$": {
758 "type": "array",
759 "items": {
760 "type": "string"
761 }
762 }
763 }
764 }
765 }
766 },
767 "LogNames": {
768 "type": "object"
769 },
770 "LogHeaders": {
771 "type": "object"
772 },
773 "LogActions": {
774 "type": "object"
775 },
776 "LogActionsHandlers": {
777 "type": "object"
778 },
779 "Actions": {
780 "type": "object"
781 },
782 "APIModules": {
783 "type": "object"
784 },
785 "APIFormatModules": {
786 "type": "object"
787 },
788 "APIMetaModules": {
789 "type": "object"
790 },
791 "APIPropModules": {
792 "type": "object"
793 },
794 "APIListModules": {
795 "type": "object"
796 },
797 "ValidSkinNames": {
798 "type": "object"
799 },
800 "FeedClasses": {
801 "type": "object",
802 "description": "Available feeds objects"
803 },
804 "SkinOOUIThemes": {
805 "type": "object"
806 },
807 "callback": {
808 "type": [
809 "array",
810 "string"
811 ],
812 "description": "A function to be called right after MediaWiki processes this file"
813 },
814 "config": {
815 "type": "object",
816 "description": "Configuration options for this extension",
817 "properties": {
818 "_prefix": {
819 "type": "string",
820 "default": "wg",
821 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
822 }
823 },
824 "patternProperties": {
825 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
826 "properties": {
827 "_merge_strategy": {
828 "type": "string",
829 "enum": [
830 "array_merge_recursive",
831 "array_plus_2d",
832 "array_plus",
833 "array_merge"
834 ],
835 "default": "array_merge"
836 }
837 }
838 }
839 }
840 },
841 "ParserTestFiles": {
842 "type": "array",
843 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
844 },
845 "load_composer_autoloader": {
846 "type": "boolean",
847 "description": "Load the composer autoloader for this extension, if one is present"
848 }
849 }
850 }