Mediawiki-api

mediawiki-api@lists.wikimedia.org

1 participants
1265 discussions

[Mediawiki-api-announce] Breaking change in action=query&meta=siteinfo&siprop=interwikimap
by Brad Jorsch (Anomie) 18 Jun '14

18 Jun '14

The "protorel" property recently added to the output of action=query&meta=siteinfo&siprop=interwikimap was coded to include the property with a boolean true value rather than the API-standard empty string. This is now corrected, and will be deployed to WMF wikis with 1.24wmf10. At some point in the future (timeframe and details undecided yet), I would like to change the API so that boolean properties like this one will actually be a truthy value (e.g. boolean true) in JSON and other output formats. It's likely that the backwards-compatible mode would cause any other properties that are currently returning as boolean true to change to empty-string. -- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation _______________________________________________ Mediawiki-api-announce mailing list Mediawiki-api-announce(a)lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce

1 0

Changes in API action=parse&mobileformat=...
by Max Semenik 09 Jun '14

09 Jun '14

Hi, in response to bug 54607 [1], we've changed the semantics of the mobileformat parameter to action=parse == Summary == Previously, it used to accept strings 'html' or 'wml', later just 'html' and modify the structure of output (see below). This was problematic because you needed to retrieve the HTML from output in different ways, depending on whether mobileformat is specified or not. Now, mobileformat is a boolean parameter, that is if there's a 'mobileformat' parameter in request, it will be treated as "the output should be mobile-friendly", regardless of value. And the output structure will be the same. For compatibility with older callers, mobileformat=(html|wml) will be special-cased to return the older structure at least for 6 month from now. These changes will start being rolled out to the WMF sites starting from tomorrow, Tuesday October 24th and this process will be complete by October 31st. == Examples == === Non-mobile parse === api.php?action=parse&format=xml { "parse": { "title": "...", "text": { "*": "foo" } } } api.php?action=parse&format=json <?xml version="1.0"?> <api> <parse title="..." displaytitle="..."> <text xml:space="preserve">foo</text> </parse> </api> === Parse that outputs mobile HTML, old style === api.php?action=parse&format=json&mobileformat=html { "parse": { "title": "API", "text": "foo" } } api.php?action=parse&format=xml&mobileformat=html <?xml version="1.0"?> <api> <parse title="..." text="foo" displaytitle="..."> </parse> </api> === Parse that outputs mobile HTML, new style === api.php?action=parse&format=...&mobileformat Same as for non-mobile parses. == FAQ == Q: I didn't use mobileformat before, does anything change for me? A: No. Q: I use mobileformat=html, will my bot/tool be broken now? A: No, you will have 6 months to switch to new style. Q: I'm only planning to use mobileformat, what should I do? A: Just use the new style. Q: How did this format discrepancy appear in the first place? A: To err is human. ----- [1] https://bugzilla.wikimedia.org/show_bug.cgi?id=54607 -- Best regards, Max Semenik ([[User:MaxSem]])

2 2

[Mediawiki-api-announce] Change in action=expandtemplates
by Brad Jorsch (Anomie) 05 Jun '14

05 Jun '14

With Gerrit change 136799 <https://gerrit.wikimedia.org/r/#/c/136799/>, the old output format for action=expandtemplates and the generatexml parameter are deprecated, but will continue to be used for existing queries. Clients should begin using the new 'prop' parameter to action=expandtemplates, to be ready for some future date when the deprecated format and parameter are removed. There is no timeline on this removal, but it will be announced well in advance to this list. This change will be deployed to WMF wikis with 1.24wmf8, see https://www.mediawiki.org/wiki/MediaWiki_1.24/Roadmap for the schedule. This is not considered a breaking change, since the old queries will continue to work with a deprecation warning. -- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation _______________________________________________ Mediawiki-api-announce mailing list Mediawiki-api-announce(a)lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce

2 1

New "gold standard" for web API client libraries
by Frances Hocutt 03 Jun '14

03 Jun '14

Hello everyone, I'm about 2 weeks into my OPW internship, in which I'll be evaluating MediaWiki API client libraries in five languages against a standard I've written and then contributing in depth to one of them.[1] By now I have a handle on using the API and the available client libraries and I've written the standard I'll be using to evaluate these libraries.[2] Off-wiki, I've started writing a series of posts on getting acquainted with the API[3]. A few days ago I spoke at WikiConference USA on the basics of APIs and API usage--slides are up on Commons, linked to from my conference run-down.[4] If you have any comments on the standard, please leave them on the talk page or grab me in IRC (fhocutt). -Frances [1] https://www.mediawiki.org/wiki/Evaluating_and_Improving_MediaWiki_web_API_c… [2] https://www.mediawiki.org/wiki/API:Client_code/Gold_standard [3] http://franceshocutt.com/tag/api/ [4] http://franceshocutt.com/2014/06/02/wikiconference-usa-2014-rundown/

1 0

how to get a page's wikidata page id?
by Tom Malcolmson 29 May '14

29 May '14

The 'basic info' for every page includes its wikidata page id, e.g. http://en.wikipedia.org/w/index.php?title=Roy_Dowling&action=info But I don't see anyway to retrieve this. I might have thought it would be a property that could be retrieved as part of a query, but I don't see it. Am I missing something or is it not available yet? Thanks, Tom

3 3

[Mediawiki-api-announce] BREAKING CHANGE: action=logevents will no longer allow both letitle and leprefix
by Brad Jorsch (Anomie) 28 May '14

28 May '14

Gerrit change 135283 <https://gerrit.wikimedia.org/r/#/c/135283/> will cause action=logevents to return an error if both the letitle and leprefix parameters are specified. Previously specifying both of these parameters would apply both filters, making leprefix pointless if letitle matches the prefix or returning no results if not. The expected impact of this change is low, as no uses of this parameter combination were logged in the time period checked. If any client is affected by this change, it may simply remove leprefix when letitle is specified. This change will be deployed to WMF wikis with 1.24wmf7, see https://www.mediawiki.org/wiki/MediaWiki_1.24/Roadmap for the schedule. -- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation _______________________________________________ Mediawiki-api-announce mailing list Mediawiki-api-announce(a)lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce

1 0

[Mediawiki-api-announce] BREAKING CHANGE: action=edit with redirect following will no longer support replacing page text
by Brad Jorsch (Anomie) 20 May '14

20 May '14

Gerrit change 133955 <https://gerrit.wikimedia.org/r/#/c/133955/>, which I plan to merge on Thursday for deployment to WMF wikis with 1.24wmf7<https://www.mediawiki.org/wiki/MediaWiki_1.24/Roadmap>, will cause the API to report an error when action=edit is used with the "redirect" parameter and none of "appendtext", "prependtext", or "section=new" are used. This will occur regardless of whether the page being edited is actually a redirect. API action=edit has a "redirect" parameter, which will automatically edit the target page if the supplied title is a redirect. The original intention of this feature was to be used in combination with appendtext or section=new for posting notifications to user talk pages without having to first check whether the page is a redirect (see bug 24330<https://bugzilla.wikimedia.org/show_bug.cgi?id=24330>). But as currently implemented it will perform the edit even when replacement page text is supplied, which is extremely prone to error: while reviewing the patch proposing this change, I reviewed several scripts and bots that were logged as submitting API requests with this combination of parameters and every one would make erroneous edits when the target page is a redirect. Clients not using the "redirect" parameter to action=edit or clients that use it in combination with "appendtext", "prependtext", or "section=new" will not be affected by this change. Affected clients have several options for coping with this change, such as: - Stop supplying the "redirect" parameter to action=edit, which will edit the redirect page itself. - When fetching the page content to transform it for the edit, use the "redirect" parameter to action=query and submit the edit to the target page directly (and without using the "redirect" parameter to action=edit) rather than via the redirect title. - Use appendtext, prependtext, or section=new instead of loading the page's wikitext and appending or prepending content on the client side. - Detect the redirect when fetching the page content and treat the unexpected redirect as an error condition. Or handle the error returned by action=edit in whatever manner is appropriate to your script, bot, or tool. See https://www.mediawiki.org/wiki/MediaWiki_1.24/Roadmap for the deployment schedule. -- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation _______________________________________________ Mediawiki-api-announce mailing list Mediawiki-api-announce(a)lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce

1 0

Aaron Halfaker's new "MediaWiki utilities" library
by Sumana Harihareswara 06 May '14

06 May '14

https://pythonhosted.org/mediawiki-utilities/ "MediaWiki Utilities is an open source (MIT Licensed) library developed by Aaron Halfaker for extracting and processing data from MediaWiki installations, slave databases and xml dumps." It's Python, and requires Python 3 or later. For instance, check out https://pythonhosted.org/mediawiki-utilities/core/api.html . "Session – Constructs an API session with a MediaWiki installation. Contains convenience methods for accessing prop=revisions, list=usercontribs, meta=siteinfo, list=deletedrevs and list=recentchanges." -- Sumana Harihareswara Senior Technical Writer Wikimedia Foundation

1 0

MediaWiki constants for JavaScript?
by Jason Ji 29 Apr '14

29 Apr '14

Greetings! I'm back with another question. :) I know that there are several MediaWiki configuration values available in JavaScript through the object mediawiki, and I've made use of mw.config a fair bit as necessary. Right now, I want to access the enums for namespaces, such as NS_MAIN = 0 or NS_TALK = 1, from JavaScript. Are these exposed anywhere in the mediawiki object? Thanks, -- Jason Ji jason.y.ji(a)gmail.com

4 5

Bad or Invalid Token in Extension
by Justin Maldonado 28 Apr '14

28 Apr '14

I'm trying to make a simple extension that moves a page on my mediawiki site, but whether using curl or FauxRequest, I always get bad token response. Tried urlencoding, not encoding, %2B/, without +/, etc, doesn't matter. The token shown in the output looks identical to the one when requesting it from the api. I'm a total programming noob, so could be something simple, but I feel like I've been through everything at this point. Code looks like this currently using FauxRequest, with param1/2/3 coming from the parser function I'm creating. global $wgUser; $token = $token = $wgUser->editToken(); $params = new FauxRequest( array( 'action' => 'move', 'from' => "$param1", 'to' => "$param2", 'format' => 'php', 'reason' => "$param3", 'token' => "$token") ); $api = new ApiMain( $params, true); $api->execute(); $data = & $api->getResultData(); $output = "moved $param1 to $param2 - $token"; also tried the below code using curl instead, which results in bad token as well global $wgUser; $token = $wgUser->editToken(); $url = 'http://www.wikiocity.com/api.php?'; $myvars = 'action=move&format=xml&from=' . "$param1" . '&to=' . "$param2" . '&reason=' . "$param3" . '&token=' . urlencode($token); $ch = curl_init( $url ); curl_setopt( $ch, CURLOPT_POST, 1); curl_setopt( $ch, CURLOPT_POSTFIELDS, $myvars); curl_setopt( $ch, CURLOPT_FOLLOWLOCATION, 1); curl_setopt( $ch, CURLOPT_USERAGENT, 'MyCoolTool/1.1 (http://example.com/MyCoolTool/; MyCoolTool(a)example.com) BasedOnSuperLib/1.4'); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1); $response = curl_exec( $ch ); $output = "moved $param1 to $param2 - $myvars - $response"; Am I missing something in the code, or could I have a setting wrong somewhere? Any help would be hugely appreciated!

5 7

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

Mediawiki-api