-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwikipedia.json
6754 lines (6754 loc) · 240 KB
/
wikipedia.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.1",
"info": {
"version": "1.0.0",
"title": "Wikimedia REST API",
"description": "This API provides cacheable and straightforward access to Wikimedia content and data, in machine-readable formats.\n### Global Rules\n- Limit your clients to no more than 200 requests/s to this API.\n Each API endpoint's documentation may detail more specific usage limits.\n- Set a unique `User-Agent` or `Api-User-Agent` header that\n allows us to contact you quickly. Email addresses or URLs\n of contact pages work well.\n\nBy using this API, you agree to Wikimedia's [Terms of Use](https://wikimediafoundation.org/wiki/Terms_of_Use) and [Privacy Policy](https://wikimediafoundation.org/wiki/Privacy_policy). Unless otherwise specified in the endpoint documentation below, content accessed via this API is licensed under the [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) and [GFDL](https://www.gnu.org/copyleft/fdl.html) licenses, and you irrevocably agree to release modifications or additions made through this API under these licenses. See https://www.mediawiki.org/wiki/REST_API for background and details.\n### Endpoint documentation\nPlease consult each endpoint's documentation for details on:\n- Licensing information for the specific type of content\n and data served via the endpoint.\n- Stability markers to inform you about development status and\n change policy, according to\n [our API version policy](https://www.mediawiki.org/wiki/API_versioning).\n- Endpoint specific usage limits.\n",
"termsOfService": "https://wikimediafoundation.org/wiki/Terms_of_Use",
"contact": {
"name": "the Wikimedia Services team",
"url": "http://mediawiki.org/wiki/REST_API"
},
"license": {
"name": "Apache2",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"x-host-basePath": "/api/rest_v1",
"paths": {
"/page/": {
"get": {
"tags": [
"Page content"
],
"summary": "List page-related API entry points.",
"description": "Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n",
"responses": {
"200": {
"description": "A list of page-related API end points.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/listing"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false
}
},
"/page/title/{title}": {
"get": {
"tags": [
"Page content"
],
"summary": "Get revision metadata for a title.",
"description": "Returns the revision metadata for the given title. If a revision ID is provided,\nmetadata for that revision is returned, otherwise the latest revision ID is assumed.\n\nStability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable).\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The latest revision metadata for the provided title.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/revision"
}
}
}
},
"301": {
"description": "A permanent redirect is returned if the supplied article title was not in the normalized form.\nTo avoid these redirects, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform\ntitle normalization client side.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"302": {
"description": "The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects).\nThe `location` header points to the redirect target.\nIf you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"404": {
"description": "Unknown page title or no revisions found.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": true,
"x-amples": [
{
"title": "Get rev by title from storage",
"request": {
"params": {
"domain": "en.wikipedia.org",
"title": "User:BSitzmann_(WMF)/MCS/Test/Frankenstein"
}
},
"response": {
"status": 200,
"headers": {
"etag": "/.+/",
"content-type": "application/json"
},
"body": {
"items": [
{
"title": "User:BSitzmann_(WMF)/MCS/Test/Frankenstein",
"rev": "/\\d+/",
"tid": "/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/",
"comment": "/.*/",
"page_language": "en"
}
]
}
}
}
]
}
},
"/page/title/{title}/{revision}": {
"get": {
"tags": [
"Page content"
],
"summary": "Get revision metadata for a title.",
"description": "Returns the revision metadata for the given title. If a revision ID is provided,\nmetadata for that revision is returned, otherwise the latest revision ID is assumed.\n\nStability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable).\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"in": "path",
"description": "The revision id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The latest revision metadata for the provided title.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/revision"
}
}
}
},
"301": {
"description": "A permanent redirect is returned if the supplied article title was not in the normalized form.\nTo avoid these redirects, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform\ntitle normalization client side.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"302": {
"description": "The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects).\nThe `location` header points to the redirect target.\nIf you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"404": {
"description": "Unknown page title or no revisions found.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false,
"x-amples": [
{
"title": "Get rev by title from storage",
"request": {
"params": {
"domain": "en.wikipedia.org",
"title": "User:BSitzmann_(WMF)/MCS/Test/Frankenstein"
}
},
"response": {
"status": 200,
"headers": {
"etag": "/.+/",
"content-type": "application/json"
},
"body": {
"items": [
{
"title": "User:BSitzmann_(WMF)/MCS/Test/Frankenstein",
"rev": "/\\d+/",
"tid": "/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/",
"comment": "/.*/",
"page_language": "en"
}
]
}
}
}
]
}
},
"/page/html/{title}": {
"get": {
"tags": [
"Page content"
],
"summary": "Get latest HTML for a title.",
"description": "Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirect",
"in": "query",
"description": "Requests for [redirect pages](https://www.mediawiki.org/wiki/Help:Redirects) return HTTP 302 with a redirect target in `Location` header and content in the body.\nTo get a 200 response instead, supply `false` to the `redirect` parameter.\n",
"schema": {
"type": "boolean"
},
"required": false
},
{
"name": "stash",
"in": "query",
"description": "Whether to temporary stash data-parsoid in order to support transforming the\nmodified content later. If this parameter is set, requests are rate-limited on\na per-client basis (max 5 requests per second per client)\n",
"schema": {
"type": "boolean"
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The latest HTML for the given page title.\n\nSee [the MediaWiki DOM\nspec](https://www.mediawiki.org/wiki/Parsoid/MediaWiki_DOM_spec) for a\ndescription of the MediaWiki-specific semantic markup in this HTML.\nNote that additional metadata is available in the HTML head.\n",
"headers": {
"ETag": {
"description": "ETag header indicating the revision and render timeuuid\nseparated by a slash:\n\"701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc\"\nThis ETag can be passed to the HTML save end point (as\n`base_etag` POST parameter), and can also be used to retrieve\nthe exact corresponding data-parsoid metadata, by requesting\nthe specific `revision` and `tid` indicated by the `ETag`.\n",
"schema": {
"type": "string"
}
}
},
"content": {
"text/html; charset=utf-8; profile=\"https://www.mediawiki.org/wiki/Specs/HTML/2.1.0\"": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"301": {
"description": "A permanent redirect is returned if the supplied article title was not in the normalized form.\nTo avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform\ntitle normalization client-side.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"302": {
"description": "The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects).\nThe `location` header points to the redirect target, and the body contains the actual page contents as HTML.\nIf you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"404": {
"description": "Unknown page title",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": true,
"x-amples": [
{
"title": "Get html by title from storage",
"request": {
"params": {
"domain": "en.wikipedia.org",
"title": "User:BSitzmann_(WMF)/MCS/Test/Frankenstein"
}
},
"response": {
"status": 200,
"headers": {
"etag": "/.+/",
"content-type": "/^text\\/html.+/"
},
"body": "/^<!DOCTYPE html>.*/"
}
}
]
}
},
"/page/html/{title}/{revision}": {
"get": {
"tags": [
"Page content"
],
"summary": "Get HTML for a specific title/revision & optionally timeuuid.",
"description": "Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n",
"operationId": "getFormatRevision",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"in": "path",
"description": "The revision",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "redirect",
"in": "query",
"description": "Requests for [redirect pages](https://www.mediawiki.org/wiki/Help:Redirects) return HTTP 302 with a redirect target in `Location` header and content in the body.\nTo get a 200 response instead, supply `false` to the `redirect` parameter.\n",
"schema": {
"type": "boolean"
}
},
{
"name": "stash",
"in": "query",
"description": "Whether to temporary stash data-parsoid in order to support transforming the\nmodified content later. If this parameter is set, requests are rate-limited on\na per-client basis (max 5 requests per second per client)\n",
"schema": {
"type": "boolean"
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The html for the given page, revision and tid.\n\nSee [the MediaWiki DOM\nspec](https://www.mediawiki.org/wiki/Parsoid/MediaWiki_DOM_spec) for a\ndescription of the MediaWiki-specific semantic markup in this HTML.\nNote that additional metadata is available in the HTML head.\n\nThis HTML can be edited using arbitrary HTML tools. The modified HTML\ncan be converted back to wikitext using the\n[/transform/html/to/wikitext{/title}{/revision}](#!/Transforms/transform_html_to_wikitext__title___revision__post)\nentry point.\n",
"headers": {
"ETag": {
"description": "ETag header indicating the revision and render timeuuid\nseparated by a slash:\n\"701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc\"\nThis ETag can be passed to the HTML save end point (as\n`base_etag` POST parameter), and can also be used to retrieve\nthe exact corresponding data-parsoid metadata, by requesting\nthe specific `revision` and `tid` indicated by the `ETag`.\n",
"schema": {
"type": "string"
}
}
},
"content": {
"text/html; charset=utf-8; profile=\"https://www.mediawiki.org/wiki/Specs/HTML/2.1.0\"": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"301": {
"description": "A permanent redirect is returned if the supplied article title was not in the normalized form.\nTo avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform\ntitle normalization client-side.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"302": {
"description": "The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects).\nThe `location` header points to the redirect target, and the body contains the actual page revision contents as HTML.\nIf you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"400": {
"description": "Invalid revision or tid",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"403": {
"description": "Access to the specific revision is restricted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"404": {
"description": "Unknown page, revision or tid",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false
}
},
"/page/data-parsoid/{title}/{revision}/{tid}": {
"get": {
"tags": [
"Page content"
],
"summary": "Get data-parsoid metadata for a specific title/revision/tid.",
"description": "Data-parsoid is metadata used by\n[Parsoid](https://www.mediawiki.org/wiki/Parsoid) to support clean\nround-tripping conversions between HTML and Wikitext. Among other\nthings, it contains the original Wikitext offsets of each HTML\nelement, keyed by element ID. The format is unstable.\n\nThe metadata in data-parsoid is specific to a specific HTML render.\nFor this reason, you need to supply the exact `revision` and `tid` as\nprovided in the `ETag` header of the HTML response.\n\nStability: [Stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"in": "path",
"description": "The revision",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "tid",
"in": "path",
"description": "The revision's time ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirect",
"in": "query",
"description": "Requests for [redirect pages](https://www.mediawiki.org/wiki/Help:Redirects) return HTTP 302 with a redirect target in `Location` header and content in the body.\nTo get a 200 response instead, supply `false` to the `redirect` parameter.\n",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "The latest Parsoid data for the given page",
"headers": {
"ETag": {
"description": "Revision / tid: \"701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc\"",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json; charset=utf-8; profile=\"https://www.mediawiki.org/wiki/Specs/data-parsoid/2.1.0": {
"schema": {
"$ref": "#/components/schemas/data-parsoid"
}
}
}
},
"301": {
"description": "A permanent redirect is returned if the supplied article title was not in the normalized form.\nTo avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform\ntitle normalization client-side.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"302": {
"description": "The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects).\nThe `location` header points to the redirect target, and the body contains the actual data-parsoid for the redirect page.\nIf you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"400": {
"description": "Invalid revision",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"403": {
"description": "Access to the specific revision is restricted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"404": {
"description": "Unknown page, revision or tid",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false
}
},
"/page/lint/{title}": {
"get": {
"tags": [
"Page content"
],
"summary": "Get the linter errors for a specific title/revision.",
"description": "Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The lint errors for the given page and optionally revision.\n\nSee [the Linter extension docs](https://www.mediawiki.org/wiki/Extension:Linter) for more\ndetails.\n",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"301": {
"description": "A permanent redirect is returned if the supplied article title was not in the normalized form.\nTo avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform\ntitle normalization client-side.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"302": {
"description": "The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects).\nThe `location` header points to the redirect target, and the body contains the actual page revision contents as HTML.\nIf you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"400": {
"description": "Invalid revision or tid",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"403": {
"description": "Access to the specific revision is restricted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"404": {
"description": "Unknown page, revision or tid",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false
}
},
"/page/lint/{title}/{revision}": {
"get": {
"tags": [
"Page content"
],
"summary": "Get the linter errors for a specific title/revision.",
"description": "Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"in": "path",
"description": "The revision",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The lint errors for the given page and optionally revision.\n\nSee [the Linter extension docs](https://www.mediawiki.org/wiki/Extension:Linter) for more\ndetails.\n",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"301": {
"description": "A permanent redirect is returned if the supplied article title was not in the normalized form.\nTo avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform\ntitle normalization client-side.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"302": {
"description": "The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects).\nThe `location` header points to the redirect target, and the body contains the actual page revision contents as HTML.\nIf you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter.\n\nBeware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`)\nwill fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).\n"
},
"400": {
"description": "Invalid revision or tid",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"403": {
"description": "Access to the specific revision is restricted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"404": {
"description": "Unknown page, revision or tid",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false
}
},
"/page/segments/{title}": {
"get": {
"tags": [
"Page content"
],
"summary": "Fetches a segmented page to be used in machine translation",
"description": "Use this end point to fetch the segmented content of a page. Clients should\nuse the returned content in conjunction with the [language transform\nAPI](https://wikimedia.org/api/rest_v1/#!/Transform).\n\nStability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The segmented page for the given title and revision",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sourceLanguage": {
"type": "string",
"description": "The source language of the page"
},
"title": {
"type": "string",
"description": "The title of the segmented page returned"
},
"revision": {
"type": "integer",
"description": "The revision ID of the segmented page"
},
"segmentedContent": {
"type": "string",
"description": "The segmented HTML body of the contents of the page"
}
}
}
}
}
},
"400": {
"description": "Invalid revision",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"403": {
"description": "Access to the specific revision is restricted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"404": {
"description": "Unknown page or revision",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false
}
},
"/page/segments/{title}/{revision}": {
"get": {
"tags": [
"Page content"
],
"summary": "Fetches a segmented page to be used in machine translation",
"description": "Use this end point to fetch the segmented content of a page. Clients should\nuse the returned content in conjunction with the [language transform\nAPI](https://wikimedia.org/api/rest_v1/#!/Transform).\n\nStability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"in": "path",
"description": "The revision id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The segmented page for the given title and revision",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sourceLanguage": {
"type": "string",
"description": "The source language of the page"
},
"title": {
"type": "string",
"description": "The title of the segmented page returned"
},
"revision": {
"type": "integer",
"description": "The revision ID of the segmented page"
},
"segmentedContent": {
"type": "string",
"description": "The segmented HTML body of the contents of the page"
}
}
}
}
}
},
"400": {
"description": "Invalid revision",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"403": {
"description": "Access to the specific revision is restricted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"404": {
"description": "Unknown page or revision",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
}
}
}
}
},
"x-monitor": false
}
},
"/page/mobile-sections/{title}": {
"get": {
"tags": [
"Mobile"
],
"summary": "Get mobile-optimized HTML sections for a title.",
"description": "Retrieve the latest HTML for a page title optimised for viewing with\nnative mobile applications. Note that the output is split by sections.\n\nStability: [deprecated](https://www.mediawiki.org/wiki/API_versioning#Deprecated)\n\n[Here](https://lists.wikimedia.org/hyperkitty/list/[email protected]/thread/ZBYSZ4VQYIVZFOCEUNCL3ZSSIEECBK6H/) you can find\nmore information about the endpoint deprecation.\n\nPlease follow [wikitech-l](https://lists.wikimedia.org/mailman/listinfo/wikitech-l) or [mediawiki-api-announce](https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce) for announcements of breaking changes.\n",
"parameters": [
{
"name": "title",
"in": "path",
"description": "Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirect",
"in": "query",
"description": "Requests for [redirect pages](https://www.mediawiki.org/wiki/Help:Redirects) return HTTP 302 with a redirect target in `Location` header and content in the body.\nTo get a 200 response instead, supply `false` to the `redirect` parameter.\n",
"schema": {
"type": "boolean"
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "JSON containing HTML sections and metadata for the given page title.",
"content": {
"application/json; charset=utf-8; profile=\"https://www.mediawiki.org/wiki/Specs/mobile-sections/0.14.1\"": {
"schema": {
"type": "object"
}
}
},
"headers": {
"ETag": {
"description": "Syntax: \"{revision}/{tid}\". Example: \"701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc\"\n",
"schema": {
"type": "string"
}
}
}