rbmediawiki 0.2 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/util/querydesc DELETED
@@ -1,843 +0,0 @@
1
- * prop=info (in) *
2
- Get basic page information such as namespace, title, last touched date, ...
3
-
4
- This module requires read rights.
5
- Parameters:
6
- inprop - Which additional properties to get:
7
- protection - List the protection level of each page
8
- talkid - The page ID of the talk page for each non-talk page
9
- subjectid - The page ID of the parent page for each talk page
10
- Values (separate with '|'): protection, talkid, subjectid, url, readable
11
- intoken - Request a token to perform a data-modifying action on a page
12
- Values (separate with '|'): edit, delete, protect, move, block, unblock, email, import
13
- incontinue - When more results are available, use this to continue
14
- Examples:
15
- api.php?action=query&prop=info&titles=Main%20Page
16
- api.php?action=query&prop=info&inprop=protection&titles=Main%20Page
17
-
18
- * prop=revisions (rv) *
19
- Get revision information.
20
- This module may be used in several ways:
21
- 1) Get data about a set of pages (last revision), by setting titles or pageids parameter.
22
- 2) Get revisions for one given page, by using titles/pageids with start/end/limit params.
23
- 3) Get data about a set of revisions by setting their IDs with revids parameter.
24
- All parameters marked as (enum) may only be used with a single page (#2).
25
-
26
- This module requires read rights.
27
- Parameters:
28
- rvprop - Which properties to get for each revision.
29
- Values (separate with '|'): ids, flags, timestamp, user, size, comment, content
30
- Default: ids|timestamp|flags|comment|user
31
- rvlimit - limit how many revisions will be returned (enum)
32
- No more than 500 (5000 for bots) allowed.
33
- rvstartid - from which revision id to start enumeration (enum)
34
- rvendid - stop revision enumeration on this revid (enum)
35
- rvstart - from which revision timestamp to start enumeration (enum)
36
- rvend - enumerate up to this timestamp (enum)
37
- rvdir - direction of enumeration - towards "newer" or "older" revisions (enum)
38
- One value: newer, older
39
- Default: older
40
- rvuser - only include revisions made by user
41
- rvexcludeuser - exclude revisions made by user
42
- rvexpandtemplates - expand templates in revision content
43
- rvgeneratexml - generate XML parse tree for revision content
44
- rvsection - only retrieve the content of this section
45
- rvtoken - Which tokens to obtain for each revision
46
- Values (separate with '|'): rollback
47
- rvcontinue - When more results are available, use this to continue
48
- rvdiffto - Revision ID to diff each revision to.
49
- Use "prev", "next" and "cur" for the previous, next and current revision respectively.
50
- Examples:
51
- Get data with content for the last revision of titles "API" and "Main Page":
52
- api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content
53
- Get last 5 revisions of the "Main Page":
54
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment
55
- Get first 5 revisions of the "Main Page":
56
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer
57
- Get first 5 revisions of the "Main Page" made after 2006-05-01:
58
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000
59
- Get first 5 revisions of the "Main Page" that were not made made by anonymous user "127.0.0.1"
60
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1
61
- Get first 5 revisions of the "Main Page" that were made by the user "MediaWiki default"
62
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default
63
-
64
- * prop=links (pl) *
65
- Returns all links from the given page(s)
66
-
67
- This module requires read rights.
68
- Parameters:
69
- plnamespace - Show links in this namespace(s) only
70
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
71
- pllimit - How many links to return
72
- No more than 500 (5000 for bots) allowed.
73
- Default: 10
74
- plcontinue - When more results are available, use this to continue
75
- Examples:
76
- Get links from the [[Main Page]]:
77
- api.php?action=query&prop=links&titles=Main%20Page
78
- Get information about the link pages in the [[Main Page]]:
79
- api.php?action=query&generator=links&titles=Main%20Page&prop=info
80
- Get links from the Main Page in the User and Template namespaces:
81
- api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10
82
- Generator:
83
- This module may be used as a generator
84
-
85
- * prop=langlinks (ll) *
86
- Returns all interlanguage links from the given page(s)
87
-
88
- This module requires read rights.
89
- Parameters:
90
- lllimit - How many langlinks to return
91
- No more than 500 (5000 for bots) allowed.
92
- Default: 10
93
- llcontinue - When more results are available, use this to continue
94
- Examples:
95
- Get interlanguage links from the [[Main Page]]:
96
- api.php?action=query&prop=langlinks&titles=Main%20Page&redirects
97
-
98
- * prop=images (im) *
99
- Returns all images contained on the given page(s)
100
-
101
- This module requires read rights.
102
- Parameters:
103
- imlimit - How many images to return
104
- No more than 500 (5000 for bots) allowed.
105
- Default: 10
106
- imcontinue - When more results are available, use this to continue
107
- Examples:
108
- Get a list of images used in the [[Main Page]]:
109
- api.php?action=query&prop=images&titles=Main%20Page
110
- Get information about all images used in the [[Main Page]]:
111
- api.php?action=query&generator=images&titles=Main%20Page&prop=info
112
- Generator:
113
- This module may be used as a generator
114
-
115
- * prop=imageinfo (ii) *
116
- Returns image information and upload history
117
-
118
- This module requires read rights.
119
- Parameters:
120
- iiprop - What image information to get.
121
- Values (separate with '|'): timestamp, user, comment, url, size, sha1, mime, metadata, archivename, bitdepth
122
- Default: timestamp|user
123
- iilimit - How many image revisions to return
124
- No more than 500 (5000 for bots) allowed.
125
- Default: 1
126
- iistart - Timestamp to start listing from
127
- iiend - Timestamp to stop listing at
128
- iiurlwidth - If iiprop=url is set, a URL to an image scaled to this width will be returned.
129
- Only the current version of the image can be scaled.
130
- Default: -1
131
- iiurlheight - Similar to iiurlwidth. Cannot be used without iiurlwidth
132
- Default: -1
133
- iicontinue - When more results are available, use this to continue
134
- Examples:
135
- api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo
136
- api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url
137
-
138
- * prop=templates (tl) *
139
- Returns all templates from the given page(s)
140
-
141
- This module requires read rights.
142
- Parameters:
143
- tlnamespace - Show templates in this namespace(s) only
144
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
145
- tllimit - How many templates to return
146
- No more than 500 (5000 for bots) allowed.
147
- Default: 10
148
- tlcontinue - When more results are available, use this to continue
149
- Examples:
150
- Get templates from the [[Main Page]]:
151
- api.php?action=query&prop=templates&titles=Main%20Page
152
- Get information about the template pages in the [[Main Page]]:
153
- api.php?action=query&generator=templates&titles=Main%20Page&prop=info
154
- Get templates from the Main Page in the User and Template namespaces:
155
- api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10
156
- Generator:
157
- This module may be used as a generator
158
-
159
- * prop=categories (cl) *
160
- List all categories the page(s) belong to
161
-
162
- This module requires read rights.
163
- Parameters:
164
- clprop - Which additional properties to get for each category.
165
- Values (separate with '|'): sortkey, timestamp
166
- clshow - Which kind of categories to show
167
- Values (separate with '|'): hidden, !hidden
168
- cllimit - How many categories to return
169
- No more than 500 (5000 for bots) allowed.
170
- Default: 10
171
- clcontinue - When more results are available, use this to continue
172
- clcategories - Only list these categories. Useful for checking whether a certain page is in a certain category
173
- Examples:
174
- Get a list of categories [[Albert Einstein]] belongs to:
175
- api.php?action=query&prop=categories&titles=Albert%20Einstein
176
- Get information about all categories used in the [[Albert Einstein]]:
177
- api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info
178
- Generator:
179
- This module may be used as a generator
180
-
181
- * prop=extlinks (el) *
182
- Returns all external urls (not interwikies) from the given page(s)
183
-
184
- This module requires read rights.
185
- Parameters:
186
- ellimit - How many links to return
187
- No more than 500 (5000 for bots) allowed.
188
- Default: 10
189
- eloffset - When more results are available, use this to continue
190
- Examples:
191
- Get a list of external links on the [[Main Page]]:
192
- api.php?action=query&prop=extlinks&titles=Main%20Page
193
-
194
- * prop=categoryinfo (ci) *
195
- Returns information about the given categories
196
-
197
- This module requires read rights.
198
- Parameters:
199
- cicontinue - When more results are available, use this to continue
200
- Example:
201
- api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar
202
-
203
- * prop=duplicatefiles (df) *
204
- List all files that are duplicates of the given file(s).
205
-
206
- This module requires read rights.
207
- Parameters:
208
- dflimit - How many files to return
209
- No more than 500 (5000 for bots) allowed.
210
- Default: 10
211
- dfcontinue - When more results are available, use this to continue
212
- Examples:
213
- api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles
214
- api.php?action=query&generator=allimages&prop=duplicatefiles
215
- Generator:
216
- This module may be used as a generator
217
-
218
- --- --- --- --- --- --- --- --- Query: List --- --- --- --- --- --- --- ---
219
-
220
- * list=allimages (ai) *
221
- Enumerate all images sequentially
222
-
223
- This module requires read rights.
224
- Parameters:
225
- aifrom - The image title to start enumerating from.
226
- aiprefix - Search for all image titles that begin with this value.
227
- aiminsize - Limit to images with at least this many bytes
228
- aimaxsize - Limit to images with at most this many bytes
229
- ailimit - How many total images to return.
230
- No more than 500 (5000 for bots) allowed.
231
- Default: 10
232
- aidir - The direction in which to list
233
- One value: ascending, descending
234
- Default: ascending
235
- aisha1 - SHA1 hash of image
236
- aisha1base36 - SHA1 hash of image in base 36 (used in MediaWiki)
237
- aiprop - Which properties to get
238
- Values (separate with '|'): timestamp, user, comment, url, size, dimensions, mime, sha1, metadata, bitdepth
239
- Default: timestamp|url
240
- Examples:
241
- Simple Use
242
- Show a list of images starting at the letter "B"
243
- api.php?action=query&list=allimages&aifrom=B
244
- Using as Generator
245
- Show info about 4 images starting at the letter "T"
246
- api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo
247
- Generator:
248
- This module may be used as a generator
249
-
250
- * list=allpages (ap) *
251
- Enumerate all pages sequentially in a given namespace
252
-
253
- This module requires read rights.
254
- Parameters:
255
- apfrom - The page title to start enumerating from.
256
- apprefix - Search for all page titles that begin with this value.
257
- apnamespace - The namespace to enumerate.
258
- One value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
259
- Default: 0
260
- apfilterredir - Which pages to list.
261
- One value: all, redirects, nonredirects
262
- Default: all
263
- apminsize - Limit to pages with at least this many bytes
264
- apmaxsize - Limit to pages with at most this many bytes
265
- apprtype - Limit to protected pages only
266
- Values (separate with '|'): edit, move
267
- apprlevel - The protection level (must be used with apprtype= parameter)
268
- Can be empty, or Values (separate with '|'): autoconfirmed, sysop
269
- apprfiltercascade - Filter protections based on cascadingness (ignored when apprtype isn't set)
270
- One value: cascading, noncascading, all
271
- Default: all
272
- aplimit - How many total pages to return.
273
- No more than 500 (5000 for bots) allowed.
274
- Default: 10
275
- apdir - The direction in which to list
276
- One value: ascending, descending
277
- Default: ascending
278
- apfilterlanglinks - Filter based on whether a page has langlinks
279
- One value: withlanglinks, withoutlanglinks, all
280
- Default: all
281
- Examples:
282
- Simple Use
283
- Show a list of pages starting at the letter "B"
284
- api.php?action=query&list=allpages&apfrom=B
285
- Using as Generator
286
- Show info about 4 pages starting at the letter "T"
287
- api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
288
- Show content of first 2 non-redirect pages begining at "Re"
289
- api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content
290
- Generator:
291
- This module may be used as a generator
292
-
293
- * list=alllinks (al) *
294
- Enumerate all links that point to a given namespace
295
-
296
- This module requires read rights.
297
- Parameters:
298
- alcontinue - When more results are available, use this to continue.
299
- alfrom - The page title to start enumerating from.
300
- alprefix - Search for all page titles that begin with this value.
301
- alunique - Only show unique links. Cannot be used with generator or prop=ids
302
- alprop - What pieces of information to include
303
- Values (separate with '|'): ids, title
304
- Default: title
305
- alnamespace - The namespace to enumerate.
306
- One value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
307
- Default: 0
308
- allimit - How many total links to return.
309
- No more than 500 (5000 for bots) allowed.
310
- Default: 10
311
- Example:
312
- api.php?action=query&list=alllinks&alunique&alfrom=B
313
- Generator:
314
- This module may be used as a generator
315
-
316
- * list=allcategories (ac) *
317
- Enumerate all categories
318
-
319
- This module requires read rights.
320
- Parameters:
321
- acfrom - The category to start enumerating from.
322
- acprefix - Search for all category titles that begin with this value.
323
- acdir - Direction to sort in.
324
- One value: ascending, descending
325
- Default: ascending
326
- aclimit - How many categories to return.
327
- No more than 500 (5000 for bots) allowed.
328
- Default: 10
329
- acprop - Which properties to get
330
- Values (separate with '|'): size, hidden
331
- Default:
332
- Examples:
333
- api.php?action=query&list=allcategories&acprop=size
334
- api.php?action=query&generator=allcategories&gacprefix=List&prop=info
335
- Generator:
336
- This module may be used as a generator
337
-
338
- * list=allusers (au) *
339
- Enumerate all registered users
340
-
341
- This module requires read rights.
342
- Parameters:
343
- aufrom - The user name to start enumerating from.
344
- auprefix - Search for all page titles that begin with this value.
345
- augroup - Limit users to a given group name
346
- One value: bot, sysop, bureaucrat, checkuser, steward, import, transwiki, uploader, oversight, founder, rollbacker, ipblock-exempt, accountcreator, abusefilter
347
- auprop - What pieces of information to include.
348
- `groups` property uses more server resources and may return fewer results than the limit.
349
- Values (separate with '|'): blockinfo, groups, editcount, registration
350
- aulimit - How many total user names to return.
351
- No more than 500 (5000 for bots) allowed.
352
- Default: 10
353
- auwitheditsonly - Only list users who have made edits
354
- Example:
355
- api.php?action=query&list=allusers&aufrom=Y
356
-
357
- * list=backlinks (bl) *
358
- Find all pages that link to the given page
359
-
360
- This module requires read rights.
361
- Parameters:
362
- bltitle - Title to search. If null, titles= parameter will be used instead, but will be obsolete soon.
363
- blcontinue - When more results are available, use this to continue.
364
- blnamespace - The namespace to enumerate.
365
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
366
- blfilterredir - How to filter for redirects
367
- One value: all, redirects, nonredirects
368
- Default: all
369
- bllimit - How many total pages to return. If blredirect is enabled, limit applies to each level separately.
370
- No more than 500 (5000 for bots) allowed.
371
- Default: 10
372
- blredirect - If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.
373
- Examples:
374
- api.php?action=query&list=backlinks&bltitle=Main%20Page
375
- api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info
376
- Generator:
377
- This module may be used as a generator
378
-
379
- * list=blocks (bk) *
380
- List all blocked users and IP addresses.
381
-
382
- This module requires read rights.
383
- Parameters:
384
- bkstart - The timestamp to start enumerating from
385
- bkend - The timestamp to stop enumerating at
386
- bkdir - The direction in which to enumerate
387
- One value: newer, older
388
- Default: older
389
- bkids - Pipe-separated list of block IDs to list (optional)
390
- bkusers - Pipe-separated list of users to search for (optional)
391
- bkip - Get all blocks applying to this IP or CIDR range, including range blocks.
392
- Cannot be used together with bkusers. CIDR ranges broader than /16 are not accepted.
393
- bklimit - The maximum amount of blocks to list
394
- No more than 500 (5000 for bots) allowed.
395
- Default: 10
396
- bkprop - Which properties to get
397
- Values (separate with '|'): id, user, by, timestamp, expiry, reason, range, flags
398
- Default: id|user|by|timestamp|expiry|reason|flags
399
- Examples:
400
- api.php?action=query&list=blocks
401
- api.php?action=query&list=blocks&bkusers=Alice|Bob
402
-
403
- * list=categorymembers (cm) *
404
- List all pages in a given category
405
-
406
- This module requires read rights.
407
- Parameters:
408
- cmtitle - Which category to enumerate (required). Must include Category: prefix
409
- cmprop - What pieces of information to include
410
- Values (separate with '|'): ids, title, sortkey, timestamp
411
- Default: ids|title
412
- cmnamespace - Only include pages in these namespaces
413
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
414
- cmcontinue - For large categories, give the value retured from previous query
415
- cmlimit - The maximum number of pages to return.
416
- No more than 500 (5000 for bots) allowed.
417
- Default: 10
418
- cmsort - Property to sort by
419
- One value: sortkey, timestamp
420
- Default: sortkey
421
- cmdir - In which direction to sort
422
- One value: asc, desc
423
- Default: asc
424
- cmstart - Timestamp to start listing from. Can only be used with cmsort=timestamp
425
- cmend - Timestamp to end listing at. Can only be used with cmsort=timestamp
426
- cmstartsortkey - Sortkey to start listing from. Can only be used with cmsort=sortkey
427
- cmendsortkey - Sortkey to end listing at. Can only be used with cmsort=sortkey
428
- Examples:
429
- Get first 10 pages in [[Category:Physics]]:
430
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics
431
- Get page info about first 10 pages in [[Category:Physics]]:
432
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info
433
- Generator:
434
- This module may be used as a generator
435
-
436
- * list=deletedrevs (dr) *
437
- List deleted revisions.
438
- This module operates in three modes:
439
- 1) List deleted revisions for the given title(s), sorted by timestamp
440
- 2) List deleted contributions for the given user, sorted by timestamp (no titles specified)
441
- 3) List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set)
442
- Certain parameters only apply to some modes and are ignored in others.
443
- For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3.
444
-
445
- This module requires read rights.
446
- Parameters:
447
- drstart - The timestamp to start enumerating from. (1,2)
448
- drend - The timestamp to stop enumerating at. (1,2)
449
- drdir - The direction in which to enumerate. (1,2)
450
- One value: newer, older
451
- Default: older
452
- drfrom - Start listing at this title (3)
453
- drcontinue - When more results are available, use this to continue (3)
454
- drunique - List only one revision for each page (3)
455
- druser - Only list revisions by this user
456
- drexcludeuser - Don't list revisions by this user
457
- drnamespace - Only list pages in this namespace (3)
458
- One value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
459
- Default: 0
460
- drlimit - The maximum amount of revisions to list
461
- No more than 500 (5000 for bots) allowed.
462
- Default: 10
463
- drprop - Which properties to get
464
- Values (separate with '|'): revid, user, comment, minor, len, content, token
465
- Default: user|comment
466
- Examples:
467
- List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1):
468
- api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content
469
- List the last 50 deleted contributions by Bob (mode 2):
470
- api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50
471
- List the first 50 deleted revisions in the main namespace (mode 3):
472
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50
473
- List the first 50 deleted pages in the Talk namespace (mode 3):
474
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique
475
-
476
- * list=embeddedin (ei) *
477
- Find all pages that embed (transclude) the given title
478
-
479
- This module requires read rights.
480
- Parameters:
481
- eititle - Title to search. If null, titles= parameter will be used instead, but will be obsolete soon.
482
- eicontinue - When more results are available, use this to continue.
483
- einamespace - The namespace to enumerate.
484
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
485
- eifilterredir - How to filter for redirects
486
- One value: all, redirects, nonredirects
487
- Default: all
488
- eilimit - How many total pages to return.
489
- No more than 500 (5000 for bots) allowed.
490
- Default: 10
491
- Examples:
492
- api.php?action=query&list=embeddedin&eititle=Template:Stub
493
- api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info
494
- Generator:
495
- This module may be used as a generator
496
-
497
- * list=imageusage (iu) *
498
- Find all pages that use the given image title.
499
-
500
- This module requires read rights.
501
- Parameters:
502
- iutitle - Title to search. If null, titles= parameter will be used instead, but will be obsolete soon.
503
- iucontinue - When more results are available, use this to continue.
504
- iunamespace - The namespace to enumerate.
505
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
506
- iufilterredir - How to filter for redirects
507
- One value: all, redirects, nonredirects
508
- Default: all
509
- iulimit - How many total pages to return. If iuredirect is enabled, limit applies to each level separately.
510
- No more than 500 (5000 for bots) allowed.
511
- Default: 10
512
- iuredirect - If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.
513
- Examples:
514
- api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg
515
- api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info
516
- Generator:
517
- This module may be used as a generator
518
-
519
- * list=logevents (le) *
520
- Get events from logs.
521
-
522
- This module requires read rights.
523
- Parameters:
524
- leprop - Which properties to get
525
- Values (separate with '|'): ids, title, type, user, timestamp, comment, details
526
- Default: ids|title|type|user|timestamp|comment|details
527
- letype - Filter log entries to only this type(s)
528
- Can be empty, or One value: block, protect, rights, delete, upload, move, import, patrol, merge, suppress, makebot, gblblock, renameuser, globalauth, gblrights, abusefilter, newusers
529
- lestart - The timestamp to start enumerating from.
530
- leend - The timestamp to end enumerating.
531
- ledir - In which direction to enumerate.
532
- One value: newer, older
533
- Default: older
534
- leuser - Filter entries to those made by the given user.
535
- letitle - Filter entries to those related to a page.
536
- lelimit - How many total event entries to return.
537
- No more than 500 (5000 for bots) allowed.
538
- Default: 10
539
- Example:
540
- api.php?action=query&list=logevents
541
-
542
- * list=recentchanges (rc) *
543
- Enumerate recent changes
544
-
545
- This module requires read rights.
546
- Parameters:
547
- rcstart - The timestamp to start enumerating from.
548
- rcend - The timestamp to end enumerating.
549
- rcdir - In which direction to enumerate.
550
- One value: newer, older
551
- Default: older
552
- rcnamespace - Filter log entries to only this namespace(s)
553
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
554
- rcprop - Include additional pieces of information
555
- Values (separate with '|'): user, comment, flags, timestamp, title, ids, sizes, redirect, patrolled, loginfo
556
- Default: title|timestamp|ids
557
- rctoken - Which tokens to obtain for each change
558
- Values (separate with '|'): patrol
559
- rcshow - Show only items that meet this criteria.
560
- For example, to see only minor edits done by logged-in users, set show=minor|!anon
561
- Values (separate with '|'): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled
562
- rclimit - How many total changes to return.
563
- No more than 500 (5000 for bots) allowed.
564
- Default: 10
565
- rctype - Which types of changes to show.
566
- Values (separate with '|'): edit, new, log
567
- Example:
568
- api.php?action=query&list=recentchanges
569
-
570
- * list=search (sr) *
571
- Perform a full text search
572
-
573
- This module requires read rights.
574
- Parameters:
575
- srsearch - Search for all page titles (or content) that has this value.
576
- srnamespace - The namespace(s) to enumerate.
577
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
578
- Default: 0
579
- srwhat - Search inside the text or titles.
580
- One value: title, text
581
- srredirects - Include redirect pages in the search.
582
- sroffset - Use this value to continue paging (return by query)
583
- Default: 0
584
- srlimit - How many total pages to return.
585
- No more than 500 (5000 for bots) allowed.
586
- Default: 10
587
- Examples:
588
- api.php?action=query&list=search&srsearch=meaning
589
- api.php?action=query&list=search&srwhat=text&srsearch=meaning
590
- api.php?action=query&generator=search&gsrsearch=meaning&prop=info
591
- Generator:
592
- This module may be used as a generator
593
-
594
- * list=usercontribs (uc) *
595
- Get all edits by a user
596
-
597
- This module requires read rights.
598
- Parameters:
599
- uclimit - The maximum number of contributions to return.
600
- No more than 500 (5000 for bots) allowed.
601
- Default: 10
602
- ucstart - The start timestamp to return from.
603
- ucend - The end timestamp to return to.
604
- uccontinue - When more results are available, use this to continue.
605
- ucuser - The user to retrieve contributions for.
606
- ucuserprefix - Retrieve contibutions for all users whose names begin with this value. Overrides ucuser.
607
- ucdir - The direction to search (older or newer).
608
- One value: newer, older
609
- Default: older
610
- ucnamespace - Only list contributions in these namespaces
611
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
612
- ucprop - Include additional pieces of information
613
- Values (separate with '|'): ids, title, timestamp, comment, flags, patrolled
614
- Default: ids|title|timestamp|flags|comment
615
- ucshow - Show only items that meet this criteria, e.g. non minor edits only: show=!minor
616
- NOTE: if show=patrolled or show=!patrolled is set, revisions older than $wgRCMaxAge won't be shown
617
- Values (separate with '|'): minor, !minor, patrolled, !patrolled
618
- Examples:
619
- api.php?action=query&list=usercontribs&ucuser=YurikBot
620
- api.php?action=query&list=usercontribs&ucuserprefix=217.121.114.
621
-
622
- * list=watchlist (wl) *
623
- Get all recent changes to pages in the logged in user's watchlist
624
-
625
- This module requires read rights.
626
- Parameters:
627
- wlallrev - Include multiple revisions of the same page within given timeframe.
628
- wlstart - The timestamp to start enumerating from.
629
- wlend - The timestamp to end enumerating.
630
- wlnamespace - Filter changes to only the given namespace(s).
631
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
632
- wldir - In which direction to enumerate pages.
633
- One value: newer, older
634
- Default: older
635
- wllimit - How many total results to return per request.
636
- No more than 500 (5000 for bots) allowed.
637
- Default: 10
638
- wlprop - Which additional items to get (non-generator mode only).
639
- Values (separate with '|'): ids, title, flags, user, comment, timestamp, patrol, sizes
640
- Default: ids|title|flags
641
- wlshow - Show only items that meet this criteria.
642
- For example, to see only minor edits done by logged-in users, set show=minor|!anon
643
- Values (separate with '|'): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled
644
- Examples:
645
- api.php?action=query&list=watchlist
646
- api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment
647
- api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment
648
- api.php?action=query&generator=watchlist&prop=info
649
- api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user
650
- Generator:
651
- This module may be used as a generator
652
-
653
- * list=watchlistraw (wr) *
654
- Get all pages on the logged in user's watchlist
655
-
656
- This module requires read rights.
657
- Parameters:
658
- wrcontinue - When more results are available, use this to continue
659
- wrnamespace - Only list pages in the given namespace(s).
660
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
661
- wrlimit - How many total results to return per request.
662
- No more than 500 (5000 for bots) allowed.
663
- Default: 10
664
- wrprop - Which additional properties to get (non-generator mode only).
665
- Values (separate with '|'): changed
666
- wrshow - Only list items that meet these criteria.
667
- Values (separate with '|'): changed, !changed
668
- Examples:
669
- api.php?action=query&list=watchlistraw
670
- api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=revisions
671
- Generator:
672
- This module may be used as a generator
673
-
674
- * list=exturlusage (eu) *
675
- Enumerate pages that contain a given URL
676
-
677
- This module requires read rights.
678
- Parameters:
679
- euprop - What pieces of information to include
680
- Values (separate with '|'): ids, title, url
681
- Default: ids|title|url
682
- euoffset - Used for paging. Use the value returned for "continue"
683
- euprotocol - Protocol of the url. If empty and euquery set, the protocol is http.
684
- Leave both this and euquery empty to list all external links
685
- Can be empty, or One value: http, https, ftp, irc, gopher, telnet, nntp, worldwind, mailto, news, svn
686
- Default:
687
- euquery - Search string without protocol. See [[Special:LinkSearch]]. Leave empty to list all external links
688
- eunamespace - The page namespace(s) to enumerate.
689
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
690
- eulimit - How many pages to return.
691
- No more than 500 (5000 for bots) allowed.
692
- Default: 10
693
- Example:
694
- api.php?action=query&list=exturlusage&euquery=www.mediawiki.org
695
- Generator:
696
- This module may be used as a generator
697
-
698
- * list=users (us) *
699
- Get information about a list of users
700
-
701
- This module requires read rights.
702
- Parameters:
703
- usprop - What pieces of information to include
704
- blockinfo - tags if the user is blocked, by whom, and for what reason
705
- groups - lists all the groups the user belongs to
706
- editcount - adds the user's edit count
707
- registration - adds the user's registration timestamp
708
- emailable - tags if the user can and wants to receive e-mail through [[Special:Emailuser]]
709
- Values (separate with '|'): blockinfo, groups, editcount, registration, emailable
710
- ususers - A list of users to obtain the same information for
711
- Example:
712
- api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount
713
-
714
- * list=random (rn) *
715
- Get a set of random pages
716
- NOTE: Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, "Main Page" is the first
717
- random page on your list, "List of fictional monkeys" will *always* be second, "List of people on stamps of Vanuatu" third, etc.
718
- NOTE: If the number of pages in the namespace is lower than rnlimit, you will get fewer pages. You will not get the same page twice.
719
-
720
- This module requires read rights.
721
- Parameters:
722
- rnnamespace - Return pages in these namespaces only
723
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
724
- rnlimit - Limit how many random pages will be returned
725
- No more than 10 (20 for bots) allowed.
726
- Default: 1
727
- rnredirect - Load a random redirect instead of a random page
728
- Example:
729
- api.php?action=query&list=random&rnnamespace=0&rnlimit=2
730
- Generator:
731
- This module may be used as a generator
732
-
733
- * list=protectedtitles (pt) *
734
- List all titles protected from creation
735
-
736
- This module requires read rights.
737
- Parameters:
738
- ptnamespace - Only list titles in these namespaces
739
- Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101
740
- ptlevel - Only list titles with these protection levels
741
- Values (separate with '|'): autoconfirmed, sysop
742
- ptlimit - How many total pages to return.
743
- No more than 500 (5000 for bots) allowed.
744
- Default: 10
745
- ptdir - The direction in which to list
746
- One value: older, newer
747
- Default: older
748
- ptstart - Start listing at this protection timestamp
749
- ptend - Stop listing at this protection timestamp
750
- ptprop - Which properties to get
751
- Values (separate with '|'): timestamp, user, comment, expiry, level
752
- Default: timestamp|level
753
- Example:
754
- api.php?action=query&list=protectedtitles
755
- Generator:
756
- This module may be used as a generator
757
-
758
- * list=globalblocks (bg) *
759
- List all globally blocked IP addresses.
760
-
761
- This module requires read rights.
762
- Parameters:
763
- bgstart - The timestamp to start enumerating from
764
- bgend - The timestamp to stop enumerating at
765
- bgdir - The direction in which to enumerate
766
- One value: newer, older
767
- Default: older
768
- bgids - Pipe-separated list of block IDs to list (optional)
769
- bgaddresses - Pipe-separated list of addresses to search for (optional)
770
- bgip - Get all blocks applying to this IP or CIDR range, including range blocks.
771
- Cannot be used together with bkusers. CIDR ranges broader than /16 are not accepted.
772
- bglimit - The maximum amount of blocks to list
773
- No more than 500 (5000 for bots) allowed.
774
- Default: 10
775
- bgprop - Which properties to get
776
- Values (separate with '|'): id, address, by, timestamp, expiry, reason, range
777
- Default: id|address|by|timestamp|expiry|reason
778
- Examples:
779
- api.php?action=query&list=globalblocks
780
- api.php?action=query&list=globalblocks&bgip=217.121.114.116
781
-
782
- --- --- --- --- --- --- --- --- Query: Meta --- --- --- --- --- --- --- ---
783
-
784
- * meta=siteinfo (si) *
785
- Return general information about the site.
786
-
787
- This module requires read rights.
788
- Parameters:
789
- siprop - Which sysinfo properties to get:
790
- general - Overall system information
791
- namespaces - List of registered namespaces and their canonical names
792
- namespacealiases - List of registered namespace aliases
793
- specialpagealiases - List of special page aliases
794
- magicwords - List of magic words and their aliases
795
- statistics - Returns site statistics
796
- interwikimap - Returns interwiki map (optionally filtered)
797
- dbrepllag - Returns database server with the highest replication lag
798
- usergroups - Returns user groups and the associated permissions
799
- extensions - Returns extensions installed on the wiki
800
- fileextensions - Returns list of file extensions allowed to be uploaded
801
- rightsinfo - Returns wiki rights (license) information if available
802
- Values (separate with '|'): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, extensions, fileextensions, rightsinfo
803
- Default: general
804
- sifilteriw - Return only local or only nonlocal entries of the interwiki map
805
- One value: local, !local
806
- sishowalldb - List all database servers, not just the one lagging the most
807
- Examples:
808
- api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics
809
- api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local
810
- api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb
811
-
812
- * meta=userinfo (ui) *
813
- Get information about the current user
814
-
815
- This module requires read rights.
816
- Parameters:
817
- uiprop - What pieces of information to include
818
- blockinfo - tags if the current user is blocked, by whom, and for what reason
819
- hasmsg - adds a tag "message" if the current user has pending messages
820
- groups - lists all the groups the current user belongs to
821
- rights - lists of all rights the current user has
822
- options - lists all preferences the current user has set
823
- editcount - adds the current user's edit count
824
- ratelimits - lists all rate limits applying to the current user
825
- Values (separate with '|'): blockinfo, hasmsg, groups, rights, options, preferencestoken, editcount, ratelimits, email
826
- Examples:
827
- api.php?action=query&meta=userinfo
828
- api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg
829
-
830
- * meta=allmessages (am) *
831
- Return messages from this site.
832
-
833
- This module requires read rights.
834
- Parameters:
835
- ammessages - Which messages to output. "*" means all messages
836
- Default: *
837
- amfilter - Return only messages that contain this string
838
- amlang - Return messages in this language
839
- amfrom - Return messages starting at this message
840
- Examples:
841
- api.php?action=query&meta=allmessages&amfilter=ipb-
842
- api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de
843
-