Page MenuHomePhabricator

Use core edit notices API instead of the VisualEditor API in the Android app
Closed, ResolvedPublic

Description

In task T201597, the edit notices were added to the Android app by using the internal API of VisualEditor:

We'd like to be able to make breaking changes to that API without consulting anyone. Also, the API output includes a lot of things that are probably irrelevant for the app, and are generated and downloaded unnecessarily. Please change it to use the core API prop=info&inprop=editintro, which I am introducing in T45683.

The new API provides the response in mostly the same format, only slight changes should be needed to call the API with different parameters and read the response from different properties. (But if you're already using the prop=info or prop=revisions API somewhere, you could optimize their use by combining the requests.)

Event Timeline

@matmarex Thanks! This is a very welcome update.
Do you have an idea of the general timeline for making breaking changes to the visualeditor API? After we release an update that uses this new API, there will still be a long tail of users who won't upgrade to the latest version for a while.

Do you have an idea of the general timeline for making breaking changes to the visualeditor API? After we release an update that uses this new API, there will still be a long tail of users who won't upgrade to the latest version for a while.

No, and there isn't a plan for any specific breaking changes. I'm just thinking of the far future – a few years from now, there might not be anyone who still remembers that the apps depend on the internal VE API on either of the teams, and someone could make a breaking change reasoning that the API is marked as internal, and everyone using the app will be very sad.

LGoto triaged this task as High priority.Jun 13 2023, 4:27 PM
LGoto lowered the priority of this task from High to Medium.

Note for QA: edit notices should behave the same as before. You can find one easily by navigating to today's featured article and trying to edit it.

ABorbaWMF subscribed.

Edit notices are displayed as expected on 2.7.50447-beta-2023-06-28