API talk:Revisions

From mediawiki.org
Latest comment: 2 months ago by Bináris in topic Use case for sha1

Omissions in Documentation[edit]

Someone who is knowledgable about the details should update the documentation here. The examples use the parameter "formatversion", but this parameter is not documented in the table.


API:Usercontribs includes sizediff in its ucprop. Why doesn't this module include the same? --2601:140:8980:FE0:50B8:7ADD:EA94:2B6B 14:47, 7 March 2018 (UTC)Reply[reply]


Need to explain "userhidden" and "anon" a bit more. See also API_talk:Database_field_and_API_property_associations.  « Saper // talk »  17:05, 27 May 2015 (UTC)Reply[reply]

Yeah, that would be usefull. --jobu0101 (talk) 09:06, 4 March 2016 (UTC)Reply[reply]
Not sure where to put it, but the userhidden flag is true when a revision has been revision-deleted and the user's name has been removed as part of that. The anon flag simply flags a revision as having been done by an IP user. I'm not sure if this is even possible, but I suppose it would help to distinguish between a user who chooses the name "" as compared to someone editing from the IP address "". Robin Hood  (talk) 21:43, 4 March 2016 (UTC)Reply[reply]


Can I have revision history with id's of user, which have reviewed every revision. Malarz pl (talk) 09:59, 13 April 2016 (UTC)Reply[reply]

I'm not sure if this is possible or not, as I have no experience with FlaggedRevs, but you might want to have a look at their API docs and see if anything there helps. If not, I'd suggest asking on that talk page rather than this one, as you're more likely to find people who have the experience to answer your question. Robin Hood  (talk) 21:43, 13 April 2016 (UTC)Reply[reply]
Thanks. I alreaeady asked there. Malarz pl (talk) 06:29, 14 April 2016 (UTC)Reply[reply]
And I added infromation to this page. Malarz pl (talk) 06:52, 14 April 2016 (UTC)Reply[reply]
Sorry, I just removed that same info. Generally speaking, info for various extensions, even those used by MediaWiki sites, are only documented on the extension's page. I don't know if there's ever been a formal discussion about that, though, so if you want to bring it to somewhere like the Community Portal or wherever, I'm certainly open to discussing/changing that policy. Robin Hood  (talk) 07:46, 14 April 2016 (UTC)Reply[reply]

Deprecated parameters[edit]

Hello, I just noticed these warnings when running some ajax script:

The parameter "rvdifftotext" has been deprecated.
The parameter "rvdifftotextpst" has been deprecated.

Indeed, there has been a bunch of deprecations: T164106 Deprecate parsing and diff options in ApiQueryRevisionsBase. The documentation of this page should be updated accordingly.

Od1n (talk) 06:35, 29 December 2017 (UTC)Reply[reply]

Exhaustive list, from the Gerrit changeset: "The 'rvdifftotext', 'rvdifftotextpst', 'rvdiffto', 'rvexpandtemplates', 'rvgeneratexml', 'rvparse', and 'rvprop=parsetree' parameters to prop=revisions are deprecated, as are the similarly named parameters to prop=deletedrevisions, list=allrevisions, and list=alldeletedrevisions. Use action=compare, action=parse, or action=expandtemplates instead."
Od1n (talk) 06:38, 29 December 2017 (UTC)Reply[reply]
All done - Special:Diff/2673288 (API:Alldeletedrevisions), Special:Diff/2673287 (API:Allrevisions), Special:Diff/2673286 (API:Deletedrevisions), and Special:Diff/2673285 (API:Revisions). SamanthaNguyen (talk) 19:30, 29 December 2017 (UTC)Reply[reply]

rvslots & rvprop[edit]


When I use the revisions API with the rvprop parameter, I get the following warning:

Because "rvslots" was not specified, a legacy format has been used for the output. This format is deprecated, and in the future the new format will always be used

See the following request, for example: [1].

It seems that "rvslots" isn't documented on this page. How should this parameter be used?

Thanks! 08:27, 3 August 2018 (UTC)Reply[reply]

This is the first I'm hearing of it myself, because I don't have the time/energy to keep up on every last change the MW team makes, but this seems to be a fairly major change to the MediaWiki architecture called "Multi-Content Revisions". Right now, it only even exists in the WMF beta builds, it's not in the 1.31 release. High-level documentation about MCR is here. The gist of it seems to be that instead of storing just a single text block for any given revision, data could be separated out into different "slots" which represent different aspects of the data. For example, infoboxes could be stored in one slot, separate from the main content of a revision; template parameters could become part of the metadata for a template rather than relying on only human-readable documentation (I gather this sort of exists on MW already via JSON data, but I'm not sure of the specifics); even the regular page content could be separated into different types of data, if appropriate. One might even be able to use this to store multi-language content in a less kludgey way, though I'm not sure if that's something that's really on the drawing board at this point.
Being such a large change, I think it's best to continue doing things the old way for now, and wait for the MCR team to provide full documentation. Robin Hood  (talk) 21:20, 3 August 2018 (UTC)Reply[reply]
+1, if there is a date for sunsetting the old format that would be of great help too. zzn 20:29, 29 October 2018 (UTC)Reply[reply]
Thank you very much for all the info! 08:29, 7 August 2018 (UTC)Reply[reply]

section numbering inconsistency when using Examples[edit]

    1 API documentation
    2 Examples
        2.1 Example 1: Get revision data of several pages
            2.1.1 GET request
            2.1.2 Response
            2.1.3 Sample Code
        2.6 Example 2: Get last five revisions of a page filtered by date and user
            2.6.1 GET request
            2.6.2 Response
            2.6.3 Sample Code
        2.11 Example 3: Get last revision of a page, following any redirects
            2.11.1 GET request
            2.11.2 Response
    3 Possible errors
    4 Additional notes
    5 Parameter history
    6 See also

Christian FR (talk) 19:52, 3 January 2020 (UTC)Reply[reply]

Corrected as :

    1 API documentation
    2 Example 1: Get revision data of several pages
        2.1 GET request
        2.2 Response
        2.3 Sample Code
    3 Example 2: Get last five revisions of a page filtered by date and user
        3.1 GET request
        3.2 Response
        3.3 Sample Code
    4 Example 3: Get last revision of a page, following any redirects
        4.1 GET request
        4.2 Response
    5 Possible errors
    6 Additional notes
    7 Parameter history
    8 See also

Christian FR (talk) 19:59, 3 January 2020 (UTC)Reply[reply]

Erreur parsoidserver[edit]

j'ai crée une nouvelle instance de mon wiki Mediawiki version 1.25.1 et a chaque fois ou je veux éditer un texte il m'affiche ce message: Erreur lors du chargement des données du serveur : 404: parsoidserver-http: HTTP 404. Voulez-vous réessayer ?

Use case for sha1[edit]

Can you tell me what is sha1 good for? Bináristalk 14:45, 6 March 2023 (UTC)Reply[reply]

You can compare revisions using their sha1s instead of comparing the whole text. For example if you want to find the number reverts in an article in a period of time, it should be a lot faster to look for the number of duplicate sha1s in the history. Dalba 05:17, 23 March 2023 (UTC)Reply[reply]

Thank you!

Should anyone be interested in further details: https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/thread/32ACOZD33HMVOGFTOQENVHZ3L7JBJIKL/ Bináristalk 19:16, 23 March 2023 (UTC)Reply[reply]