[Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
Previous announcement: https://lists.wikimedia.org/pipermail/mediawiki-api-announce/2014-September/69.html During the 1.25 development cycle, the API has been warning you if you're specifying neither the "continue" nor "rawcontinue" parameters to action=query. Recently this warning was targeted more specifically to queries that actually return continuation data. The time is coming soon for making this change, so please check your bots, bot frameworks, scripts, and so on to ensure that you won't be broken when this change is made. If you want to continue using your existing continuation code unchanged, all you need to do is add the "rawcontinue" parameter to your action=query queries. If you'd rather change to the easier-to-get-right new style, add an empty "continue" parameter to your initial action=query queries. See https://www.mediawiki.org/wiki/API:Query#Continuing_queries for details on the new mechanism. If you do nothing, sometime in the next few months your code will likely start thinking that no queries ever need continuation when the default is changed to return the new 'continue' node rather than the old 'query-continue'. I'll send an announcement when the specific date is decided, but I don't promise more than a week's notice. -- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
It would help to surface api deprecation notices into the JavaScript console just like mw.deprecate does for more visibility. I haven't got time to review every single API response for every request mobile makes and I'm keen to help you be able to iterate on the API quicker... Jon On Fri, Apr 17, 2015 at 7:58 AM, Brad Jorsch (Anomie) wrote: > Previous announcement: > https://lists.wikimedia.org/pipermail/mediawiki-api-announce/2014-September/69.html > > During the 1.25 development cycle, the API has been warning you if you're > specifying neither the "continue" nor "rawcontinue" parameters to > action=query. Recently this warning was targeted more specifically to > queries that actually return continuation data. The time is coming soon for > making this change, so please check your bots, bot frameworks, scripts, and > so on to ensure that you won't be broken when this change is made. > > If you want to continue using your existing continuation code unchanged, > all you need to do is add the "rawcontinue" parameter to your action=query > queries. > > If you'd rather change to the easier-to-get-right new style, add an empty > "continue" parameter to your initial action=query queries. See > https://www.mediawiki.org/wiki/API:Query#Continuing_queries for details on > the new mechanism. > > If you do nothing, sometime in the next few months your code will likely > start thinking that no queries ever need continuation when the default is > changed to return the new 'continue' node rather than the old > 'query-continue'. I'll send an announcement when the specific date is > decided, but I don't promise more than a week's notice. > > > -- > Brad Jorsch (Anomie) > Software Engineer > Wikimedia Foundation > ___ > Wikitech-l mailing list > Wikitech-l@lists.wikimedia.org > https://lists.wikimedia.org/mailman/listinfo/wikitech-l -- Jon Robson * http://jonrobson.me.uk * https://www.facebook.com/jonrobson * @rakugojon ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
On Mon, Apr 20, 2015 at 12:57 PM, Jon Robson wrote: > It would help to surface api deprecation notices into the JavaScript > console just like mw.deprecate does for more visibility. > The API can and does already report deprecation warnings, and the way that happens is on my long list of stuff to improve. And it can log on the server too (see api-feature-usage.log on fluorine). And once logstash gets working it'll even be externally queryable by user agent. But "like mw.deprecate" doesn't make sense any further than that. It's up to your API-accessing code (e.g. whatever framework you're using to query the API) to log the warnings it receives in some manner you'd find useful. -- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
I use mw.api so I suspect that to handle deprecation notices - does it not? If not why not? Basically I think these notices need to show up in php warning logs / js console to get the attention they deserve. On Mon, Apr 20, 2015 at 10:14 AM, Brad Jorsch (Anomie) wrote: > On Mon, Apr 20, 2015 at 12:57 PM, Jon Robson wrote: > >> It would help to surface api deprecation notices into the JavaScript >> console just like mw.deprecate does for more visibility. >> > > The API can and does already report deprecation warnings, and the way that > happens is on my long list of stuff to improve. And it can log on the > server too (see api-feature-usage.log on fluorine). And once logstash gets > working it'll even be externally queryable by user agent. > > But "like mw.deprecate" doesn't make sense any further than that. It's up > to your API-accessing code (e.g. whatever framework you're using to query > the API) to log the warnings it receives in some manner you'd find useful. > > > -- > Brad Jorsch (Anomie) > Software Engineer > Wikimedia Foundation > ___ > Wikitech-l mailing list > Wikitech-l@lists.wikimedia.org > https://lists.wikimedia.org/mailman/listinfo/wikitech-l -- Jon Robson * http://jonrobson.me.uk * https://www.facebook.com/jonrobson * @rakugojon ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
On Mon, Apr 20, 2015 at 1:19 PM, Jon Robson wrote: > I use mw.api so I suspect that to handle deprecation notices - does it > not? If not why not? > Because no one coded it for that framework yet? -- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
Is there a phab task for that.. ? :-) On Mon, Apr 20, 2015 at 10:21 AM, Brad Jorsch (Anomie) wrote: > On Mon, Apr 20, 2015 at 1:19 PM, Jon Robson wrote: > >> I use mw.api so I suspect that to handle deprecation notices - does it >> not? If not why not? >> > > Because no one coded it for that framework yet? > > > -- > Brad Jorsch (Anomie) > Software Engineer > Wikimedia Foundation > ___ > Wikitech-l mailing list > Wikitech-l@lists.wikimedia.org > https://lists.wikimedia.org/mailman/listinfo/wikitech-l -- Jon Robson * http://jonrobson.me.uk * https://www.facebook.com/jonrobson * @rakugojon ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
I still think that we should provide a simple API clients for JS, PHP, and python. JS version should support both Browser & node.js. The libs should handle the most rudimentary API functioning like logins, warnings, & continuation, in the way that API devs feel is best, but nothing specific to any of the modules (e.g. it should not have a separate function to get a list of all pages). On Mon, Apr 20, 2015 at 8:38 PM, Jon Robson wrote: > Is there a phab task for that.. ? :-) > > > On Mon, Apr 20, 2015 at 10:21 AM, Brad Jorsch (Anomie) > wrote: > > On Mon, Apr 20, 2015 at 1:19 PM, Jon Robson wrote: > > > >> I use mw.api so I suspect that to handle deprecation notices - does it > >> not? If not why not? > >> > > > > Because no one coded it for that framework yet? > > > > > > -- > > Brad Jorsch (Anomie) > > Software Engineer > > Wikimedia Foundation > > ___ > > Wikitech-l mailing list > > Wikitech-l@lists.wikimedia.org > > https://lists.wikimedia.org/mailman/listinfo/wikitech-l > > > > -- > Jon Robson > * http://jonrobson.me.uk > * https://www.facebook.com/jonrobson > * @rakugojon > > ___ > Wikitech-l mailing list > Wikitech-l@lists.wikimedia.org > https://lists.wikimedia.org/mailman/listinfo/wikitech-l > ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
It doesn't seem like anyone's mentioned it yet, but it would be even nicer IMHO to not even worry about this class of problems by versioning the API itself. This way, you can provide an explicit "upgrade" path for actively-developed clients while keeping old versions around for legacy clients. As a result, marking an old (or previously deprecated) API (version) obsolete will only effect clients who haven't upgraded to the new version. On Mon, Apr 20, 2015 at 1:51 PM, Yuri Astrakhan wrote: > I still think that we should provide a simple API clients for JS, PHP, and > python. JS version should support both Browser & node.js. The libs should > handle the most rudimentary API functioning like logins, warnings, & > continuation, in the way that API devs feel is best, but nothing specific > to any of the modules (e.g. it should not have a separate function to get a > list of all pages). > > On Mon, Apr 20, 2015 at 8:38 PM, Jon Robson wrote: > > > Is there a phab task for that.. ? :-) > > > > > > On Mon, Apr 20, 2015 at 10:21 AM, Brad Jorsch (Anomie) > > wrote: > > > On Mon, Apr 20, 2015 at 1:19 PM, Jon Robson > wrote: > > > > > >> I use mw.api so I suspect that to handle deprecation notices - does it > > >> not? If not why not? > > >> > > > > > > Because no one coded it for that framework yet? > > > > > > > > > -- > > > Brad Jorsch (Anomie) > > > Software Engineer > > > Wikimedia Foundation > > > ___ > > > Wikitech-l mailing list > > > Wikitech-l@lists.wikimedia.org > > > https://lists.wikimedia.org/mailman/listinfo/wikitech-l > > > > > > > > -- > > Jon Robson > > * http://jonrobson.me.uk > > * https://www.facebook.com/jonrobson > > * @rakugojon > > > > ___ > > Wikitech-l mailing list > > Wikitech-l@lists.wikimedia.org > > https://lists.wikimedia.org/mailman/listinfo/wikitech-l > > > ___ > Wikitech-l mailing list > Wikitech-l@lists.wikimedia.org > https://lists.wikimedia.org/mailman/listinfo/wikitech-l > -- EN Wikipedia user page: https://en.wikipedia.org/wiki/User:Brian.gerstle IRC: bgerstle ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Re: [Wikitech-l] Reminder: Breaking change to API continuation planned for 1.26
On Mon, Apr 20, 2015 at 11:49 AM, Brian Gerstle wrote: > It doesn't seem like anyone's mentioned it yet, but it would be even nicer > IMHO to not even worry about this class of problems by versioning the API > itself. This way, you can provide an explicit "upgrade" path for > actively-developed clients while keeping old versions around for legacy > clients. As a result, marking an old (or previously deprecated) API > (version) obsolete will only effect clients who haven't upgraded to the new > version. Hmppf You're not alone - https://phabricator.wikimedia.org/T41592 (this bug was closed as declined) > > On Mon, Apr 20, 2015 at 1:51 PM, Yuri Astrakhan > wrote: > >> I still think that we should provide a simple API clients for JS, PHP, and >> python. JS version should support both Browser & node.js. The libs should >> handle the most rudimentary API functioning like logins, warnings, & >> continuation, in the way that API devs feel is best, but nothing specific >> to any of the modules (e.g. it should not have a separate function to get a >> list of all pages). >> >> On Mon, Apr 20, 2015 at 8:38 PM, Jon Robson wrote: >> >> > Is there a phab task for that.. ? :-) >> > >> > >> > On Mon, Apr 20, 2015 at 10:21 AM, Brad Jorsch (Anomie) >> > wrote: >> > > On Mon, Apr 20, 2015 at 1:19 PM, Jon Robson >> wrote: >> > > >> > >> I use mw.api so I suspect that to handle deprecation notices - does it >> > >> not? If not why not? >> > >> >> > > >> > > Because no one coded it for that framework yet? >> > > >> > > >> > > -- >> > > Brad Jorsch (Anomie) >> > > Software Engineer >> > > Wikimedia Foundation >> > > ___ >> > > Wikitech-l mailing list >> > > Wikitech-l@lists.wikimedia.org >> > > https://lists.wikimedia.org/mailman/listinfo/wikitech-l >> > >> > >> > >> > -- >> > Jon Robson >> > * http://jonrobson.me.uk >> > * https://www.facebook.com/jonrobson >> > * @rakugojon >> > >> > ___ >> > Wikitech-l mailing list >> > Wikitech-l@lists.wikimedia.org >> > https://lists.wikimedia.org/mailman/listinfo/wikitech-l >> > >> ___ >> Wikitech-l mailing list >> Wikitech-l@lists.wikimedia.org >> https://lists.wikimedia.org/mailman/listinfo/wikitech-l >> > > > > -- > EN Wikipedia user page: https://en.wikipedia.org/wiki/User:Brian.gerstle > IRC: bgerstle > ___ > Wikitech-l mailing list > Wikitech-l@lists.wikimedia.org > https://lists.wikimedia.org/mailman/listinfo/wikitech-l -- Jon Robson * http://jonrobson.me.uk * https://www.facebook.com/jonrobson * @rakugojon ___ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l