Deprecate and remove Parsoid's "v1" API (and also the "v2" API while we're at it)
Closed, ResolvedPublic
Actions

Description

There are too many different variants of the Parsoid API url scheme:

Parsoid's "v1" API.
Parsoid's "v2" API.
Parsoid's "v3" API
RESTbase's API, which is a hybrid of Parsoid's v1 and v2 API with some unique features of its own (ie POST parameters named "wikitext" and "bodyOnly" instead of "wt" and "body").
The API exposed by the ParsoidVirtualRESTService in mediawiki core, which claims to be a mirror of Parsoid's "v1" API, but in fact contains features of the RESTbase API (ie, the /transform/X/to/Y/ route, and the use of a POST parameter named "wikitext").

The latter API is the one used by the Visual Editor code base, and mediawiki-core contains code to munge it into both Parsoid's *actual* v1 API and the RESTbase API.

In this task I plan to (a) update ParsoidVirtualRESTService to always issue v3 API requests, then (b) update VisualEditor to use the RESTBase v1 API/Parsoid v3 API via VRS instead of it's crazy hybrid, (c) update RESTBase to issue v3 API requests, and (d) update Flow to use the RESTBase v1/Parsoid v3 API via VRS. We can then (e) remove "v1" and "v2" API support from Parsoid.

This will take us from 4 similar-but-crazily-different APIs to only one(ish): RESTBase v1 (and Parsoid v3, which was explicitly designed to be as similar to RESTBase v1 as possible; see T100680).

This will remove a bunch of hairy URL translation code from Parsoid, RESTbase, and mediawiki-core, as well as concentrating our efforts on documenting a single API (and single way to configure Parsoid/RESTBase in mediawiki).

Details

Subject	Repo	Branch	Lines +/-
Hard deprecate support for Parsoid v1 API	mediawiki/core	master	+7 -0
Use Parsoid v3 API (which is identical to RESTBase v1 API).	mediawiki/services/cxserver	master	+5 -3
Use Parsoid v3 API; emulate the RESTBase v1 API	mediawiki/core	master	+332 -139

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Duplicate	None	T110155 Parsoid assumes $wgCapitalLinks = true
Resolved	Arlolra	T100681 Deprecate and remove Parsoid's "v1" API (and also the "v2" API while we're at it)
Resolved	cscott	T110721 Switch Flow to use Parsoid v3 API with VirtualRESTService
Resolved	cscott	T110780 Switch VisualEditor to use new RESTBase URL support in VRS
Resolved	None	T110781 Switch RESTBase to use Parsoid's "v3" API
Resolved	cscott	T110782 Parsoid v3 API support in OCG

Event Timeline

cscott created this task.May 28 2015, 6:05 PM

cscott raised the priority of this task from to Medium.

cscott updated the task description. (Show Details)

cscott added a project: Parsoid.

cscott added subscribers: cscott, Aklapper.

cscott mentioned this in T100680: Parsoid API should be closer to RESTBase API..May 28 2015, 6:16 PM

Change 217995 had a related patch set uploaded (by Cscott):
Use Parsoid v2 API

https://gerrit.wikimedia.org/r/217995

gerritbot added a project: Patch-For-Review.Jun 13 2015, 4:59 AM

Change 214351 had a related patch set uploaded (by Cscott):
Use Parsoid v2 API

https://gerrit.wikimedia.org/r/214351

Ricordisamoa subscribed.Aug 26 2015, 9:46 PM

Change 214351 merged by jenkins-bot:
Use Parsoid v3 API; emulate the RESTBase v1 API

https://gerrit.wikimedia.org/r/214351

cscott mentioned this in rMWf5c874cbaf2c: Use Parsoid v3 API; emulate the RESTBase v1 API.Aug 28 2015, 3:14 AM

• Forrestbot added projects: WMF-deploy-2015-09-01_(1.26wmf21), MW-1.26-release.Aug 28 2015, 4:00 AM

Ok, now we just need to fix Flow (T110721).

cscott added a subtask: T94574: Switch Flow from ExternalStore to RESTBase.Aug 28 2015, 5:07 PM

• Mattflaschen-WMF edited subtasks, added: T110721: Switch Flow to use Parsoid v3 API with VirtualRESTService; removed: T94574: Switch Flow from ExternalStore to RESTBase.Aug 28 2015, 7:24 PM

cscott mentioned this in T110780: Switch VisualEditor to use new RESTBase URL support in VRS.Aug 29 2015, 2:11 AM

cscott added a subtask: T110780: Switch VisualEditor to use new RESTBase URL support in VRS.

cscott removed a project: Patch-For-Review.Aug 29 2015, 2:13 AM

cscott set Security to None.

cscott added a subtask: T110781: Switch RESTBase to use Parsoid's "v3" API.Aug 29 2015, 2:15 AM

cscott renamed this task from Deprecate and remove Parsoid's "v1" API to Deprecate and remove Parsoid's "v1" API (and also the "v2" API while we're at it).Aug 29 2015, 2:19 AM

cscott updated the task description. (Show Details)

cscott added a subtask: T110782: Parsoid v3 API support in OCG.Aug 29 2015, 2:22 AM

Krenair subscribed.Aug 29 2015, 2:37 AM

All CX publishing is failing now https://phabricator.wikimedia.org/T111490

KartikMistry subscribed.Sep 4 2015, 8:22 AM

Arrbee subscribed.Sep 4 2015, 10:13 AM

In this task I plan to (a) update ParsoidVirtualRESTService to always issue v3 API requests, then (b) update VisualEditor to use the RESTBase v1 API/Parsoid v3 API via VRS instead of it's crazy hybrid, (c) update RESTBase to issue v3 API requests, and (d) update Flow to use the RESTBase v1/Parsoid v3 API via VRS. We can then (e) remove "v1" and "v2" API support from Parsoid.

CX uses parsoid, so please don't miss to notify us with phab tickets about this kind of changes in future. CX was down for hours today(T111490).

Arrbee mentioned this in T111490: Content Translation publishing fails due to Error: parsoidserver-http: HTTP 404.Sep 4 2015, 10:28 AM

• DannyH closed subtask T110721: Switch Flow to use Parsoid v3 API with VirtualRESTService as Resolved.Sep 8 2015, 5:32 PM

Jdforrester-WMF closed subtask T110780: Switch VisualEditor to use new RESTBase URL support in VRS as Resolved.Sep 10 2015, 9:01 PM

cscott closed subtask T110782: Parsoid v3 API support in OCG as Resolved.Sep 17 2015, 6:35 PM

cscott removed a project: MW-1.26-release.Sep 24 2015, 6:47 PM

Change 242570 had a related patch set uploaded (by Cscott):
Use Parsoid v3 API (which is identical to RESTBase v1 API).

https://gerrit.wikimedia.org/r/242570

gerritbot added a project: Patch-For-Review.Sep 30 2015, 2:54 PM

Change 242570 merged by jenkins-bot:
Use Parsoid v3 API (which is identical to RESTBase v1 API).

https://gerrit.wikimedia.org/r/242570

cscott mentioned this in rGCXS629b4940818a: Use Parsoid v3 API (which is identical to RESTBase v1 API)..Oct 5 2015, 6:14 AM

ssastry added a project: Parsoid-Web-API.Oct 28 2015, 5:11 PM

• Pchelolo closed subtask T110781: Switch RESTBase to use Parsoid's "v3" API as Resolved.Nov 11 2015, 3:01 PM

Arlolra added a parent task: T110155: Parsoid assumes $wgCapitalLinks = true.Nov 18 2015, 3:25 AM

Change 283593 had a related patch set uploaded (by Arlolra):
T100681: Deprecate and remove Parsoid's v1/v2 APIs

https://gerrit.wikimedia.org/r/283593

Change 283593 merged by jenkins-bot:
T100681: Remove deprecated v1/v2 HTTP APIs

https://gerrit.wikimedia.org/r/283593

Arlolra closed this task as Resolved.May 13 2016, 7:58 PM

Arlolra claimed this task.

Arlolra mentioned this in T130474: Fix broken URI in HTTP redirect (/parsoid prefix missing).May 15 2016, 12:22 AM

Mentioned in SAL [2016-05-19T18:38:24Z] <cscott> updated Parsoid to version 67816adf (T100681, T130638)

Stashbot mentioned this in T130638: Add data-mw as a separate JSON blob in the pagebundle output of Parsoid's API.May 19 2016, 6:38 PM

Change 445725 had a related patch set uploaded (by C. Scott Ananian; owner: C. Scott Ananian):
[mediawiki/core@master] Hard deprecate support for Parsoid v1 API

https://gerrit.wikimedia.org/r/445725

Change 445725 merged by jenkins-bot:
[mediawiki/core@master] Hard deprecate support for Parsoid v1 API

https://gerrit.wikimedia.org/r/445725

ReleaseTaggerBot added a project: MW-1.32-notes (WMF-deploy-2018-07-17 (1.32.0-wmf.13)).Jul 13 2018, 10:00 PM

• Petar.petkovic removed a project: Patch-For-Review.Jul 16 2018, 10:34 AM