Jump to content

API:Alldeletedrevisions

From mediawiki.org
Revision as of 14:50, 27 December 2017 by TheStoneBot (talk | contribs) (Possible errors: clean up, replaced: {{translation}} → {{#translation:}})

List all deleted revisions by a user or in a namespace.

This module lists revisions which have been deleted from a page, as you would see in Special:Undelete. It should not be confused with revisions which have been hidden via the Revision Delete feature.

Parameters

  • adrprop: Which properties to get for each revision: (Default: ids|timestamp|flags|comment|user)
    • ids: The ID of the revision.
    • flags: Revision flags (minor).
    • timestamp: The timestamp of the revision.
    • user: User that made the revision.
    • userid: User ID of the revision creator.
    • size: Length (bytes) of the revision.
    • sha1: SHA-1 (base 16) of the revision.
    • contentmodel: Content model ID of the revision.
    • comment: Comment by the user for the revision.
    • parsedcomment: Parsed comment by the user for the revision.
    • content: Text of the revision.
    • tags: Tags for the revision.
    • parsetree: The XML parse tree of revision content (requires content model wikitext).
  • adrlimit: Limit how many revisions will be returned. No more than 500 (5000 for bots) allowed. (Default: 10 (1 with content property))
  • adrexpandtemplates: Expand templates in revision content (requires adrprop=content).
  • adrgeneratexml: Deprecated. Generate XML parse tree for revision content (requires adrprop=content; replaced by adrprop=parsetree). (deprecated in 1.26)
  • adrparse: Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.
  • adrsection: Only retrieve the content of this section number.
  • adrdiffto: Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
  • adrdifftotext: Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text.
  • adrdifftotextpst: Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext. 1.27+
  • adrcontentformat: Serialization format used for adrdifftotext and expected for output of content. Possible values: application/json, text/x-wiki, text/javascript, text/css, text/plain
  • adruser: Only list revisions by this user.
  • adrnamespace: Only list pages in this namespace.
  • adrstart: The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
  • adrend: The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
  • adrdir: In which direction to enumerate: (Default: older)
    • newer: List oldest first. Note: adrstart has to be before adrend.
    • older: List newest first. Note: adrstart has to be later than adrend.
  • adrfrom: Start listing at this title.
  • adrto: Stop listing at this title.
  • adrprefix: Search for all page titles that begin with this value.
  • adrexcludeuser: Don't list revisions by this user.
  • adrtag: Only list revisions tagged with this tag.
  • adrcontinue: When more results are available, use this to continue.
  • adrgeneratetitles: When being used as a generator, generate titles rather than revision IDs. For example, if looking at the edits a particular user made, prop=revisions would, by default, return the latest revision from the pages that user edited, rather than the specific revisions they made.

Example

Get a list of deleted revisions in Main space.
Result
{
    "query": {
        "alldeletedrevisions": [
            {
                "pageid": 0,
                "revisions": [
                    {
                        "user": "Example",
                        "comment": "Test",
                        "contentformat": "text/x-wiki",
                        "contentmodel": "wikitext",
                        "content": "Page for alldeletedrevisions example"
                    }
                ],
                "ns": 0,
                "title": "ADR Page"
            }
        ]
    }
}

Possible warnings

  • Couldn't diff to r######: content is hidden
    • Thrown when the revision has been hidden (e.g., using RevisionDelete or Oversight).
  • Conversion to XML is supported for wikitext only, title uses content model content model
    • Thrown when the parsetree property or generatexml parameter is used and the content model (as returned by the content property) is not set to wikitext
  • Template expansion is supported for wikitext only, title uses content model content model
    • Thrown when the expandtemplates parameter is used and the content model (as returned by the content property) is not set to wikitext
  • The requested format contentFormat is not supported for content model model used by name
    • Thrown when the content of either the current revision or one being diffed to is not supported (typically, not text).
  • For better performance when generating titles, set gadrdir=newer
    • Thrown when using this module as a generator to enumerate pages in a namespace and using the generatetitles parameter together with dir=older (either specifically or by default).

Possible errors

Code Info
adrdiffto adrdiffto must be set to a non-negative number, "prev", "next" or "cur"
adrnosuchrevid There is no revision with ID ID
adrnosuchsection There is no section section in rID
adrpermissiondenied You don't have permission to view deleted revision information
adrpermissiondenied You don't have permission to view deleted revision content
adrbadparams The adrfrom/adrto/adrprefix/adrexcludeuser parameter cannot be used with adruser
adrbadparams The adrstart/adrend parameter may only be used with adruser


list=alldeletedrevisions (adr)

(main | query | alldeletedrevisions)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all deleted revisions by a user or in a namespace.

Specific parameters:
Other general parameters are available.
adrprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision. If the user has been revision deleted, a userhidden property will be returned.
userid
User ID of the revision creator. If the user has been revision deleted, a userhidden property will be returned.
size
Length (bytes) of the revision.
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
Comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parsed comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
content
Content of each revision slot. If the content has been revision deleted, a texthidden property will be returned. For performance reasons, if this option is used, adrlimit is enforced to 50.
tags
Tags for the revision.
roles
List content slot roles that exist in the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext). For performance reasons, if this option is used, adrlimit is enforced to 50.
Values (separate with | or alternative): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
Default: ids|timestamp|flags|comment|user
adrslots

Which revision slots to return data for, when slot-related properties are included in adrprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

Values (separate with | or alternative): main
To specify all values, use *.
adrcontentformat-{slot}

Content serialization format used for output of content.

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of adrslots.
One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
adrlimit

Limit how many revisions will be returned. If adrprop=content, adrprop=parsetree, adrdiffto or adrdifftotext is used, the limit is 50. If adrparse is used, the limit is 1.

Type: integer or max
The value must be between 1 and 500.
adrexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires adrprop=content).

Type: boolean (details)
adrgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires adrprop=content).

Type: boolean (details)
adrparse
Deprecated.

Use action=parse instead. Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.

Type: boolean (details)
adrsection

Only retrieve the content of the section with this identifier.

adrdiffto
Deprecated.

Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively. For performance reasons, if this option is used, adrlimit is enforced to 50.

adrdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text. For performance reasons, if this option is used, adrlimit is enforced to 50.

adrdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext.

Type: boolean (details)
adrcontentformat
Deprecated.

Serialization format used for adrdifftotext and expected for output of content.

One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
adruser

Only list revisions by this user.

Note: Due to miser mode, using adruser and adrnamespace together may result in fewer than adrlimit results returned before continuing; in extreme cases, zero results may be returned.

Type: user, by any of username, IP, Temporary user, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
adrnamespace

Only list pages in this namespace.

Note: Due to miser mode, using adruser and adrnamespace together may result in fewer than adrlimit results returned before continuing; in extreme cases, zero results may be returned.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 90, 91, 92, 93, 100, 101, 102, 103, 104, 105, 106, 107, 486, 487, 710, 711, 828, 829, 1198, 1199, 2600, 5500, 5501
To specify all values, use *.
adrstart

The timestamp to start enumerating from.

May only be used with adruser.
Type: timestamp (allowed formats)
adrend

The timestamp to stop enumerating at.

May only be used with adruser.
Type: timestamp (allowed formats)
adrdir

In which direction to enumerate:

newer
List oldest first. Note: adrstart has to be before adrend.
older
List newest first (default). Note: adrstart has to be later than adrend.
One of the following values: newer, older
Default: older
adrfrom

Start listing at this title.

Cannot be used with adruser.
adrto

Stop listing at this title.

Cannot be used with adruser.
adrprefix

Search for all page titles that begin with this value.

Cannot be used with adruser.
adrexcludeuser

Don't list revisions by this user.

Cannot be used with adruser.
Type: user, by any of username, IP, Temporary user, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
adrtag

Only list revisions tagged with this tag.

adrcontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

adrgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

Type: boolean (details)