Enable the REST API with the Wikibase extension
Closed, ResolvedPublic2 Estimated Story Points
Actions

Assigned To

Authored By

	Ollie.Shotton_WMDE
	Oct 25 2024, 9:34 AM

Description

Currently, the Wikibase REST API is enabled by adding $wgRestAPIAdditionalRouteFiles[] = 'extensions/Wikibase/repo/rest-api/routes.json'; to the LocalSettings.php file. This was sensible while the REST API was in beta, as it let individual instances select if they wanted to enable the REST API or not.

With the REST API v1 soon to be released, we should move the route definitions from repo/rest-api/routes.json into the extension-repo.json file so that the REST API is enabled when the Wikibase extension is loaded. This will help ensure that there is consistent functionality across all Wikibase instances.

We should also consider backporting this change to the REL1_43 LTS release.

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	REST: Create REST API v1 release and enable with Wikibase extension	mediawiki/extensions/Wikibase	REL1_43	+350 -37
	REST: Create REST API v1 release and enable with Wikibase extension	mediawiki/extensions/Wikibase	master	+350 -37

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		Ollie.Shotton_WMDE	T378175 Enable the REST API with the Wikibase extension
		Resolved		Ollie.Shotton_WMDE	T378455 Change REST API from v0 to v1

Event Timeline

Ollie.Shotton_WMDE created this task.Oct 25 2024, 9:34 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 25 2024, 9:34 AM

I think this would make a lot of sense. At the time of doing this we should probably mention something in the release notes too.

WMDE-leszek set the point value for this task to 2.Oct 28 2024, 3:32 PM

WMDE-leszek moved this task from Backlog to Polished on the Wikibase Reuse Team board.

WMDE-leszek moved this task from Polished to Ready for planning on the Wikibase Reuse Team board.

Ifrahkhanyaree_WMDE moved this task from Backlog to Next on the Wikibase REST API (WPP) board.Oct 29 2024, 8:50 AM

• Muhammad_Yasser_Jazirahly_WMDE moved this task from Ready for planning to Sprint 32 on the Wikibase Reuse Team board.Oct 29 2024, 10:43 AM

• Muhammad_Yasser_Jazirahly_WMDE edited projects, added Wikibase Reuse Team (Sprint 32); removed Wikibase Reuse Team.

WMDE-leszek added a subtask: T378455: Change REST API from v0 to v1.Oct 29 2024, 11:26 AM

Noting down the order to do things in as decided by engineers:

~~Wait for T342992: 👷️ Create a property to be marked as production ready~~ Decided not to wait for the CreateProperty endpoint just for cosmetic versioning reasons
Copy all the routes from repo/rest-api/routes.json to extension-repo.json
Change from v0 to v1 in the extension-repo.json only - as part of T378455: Change REST API from v0 to v1
Leave repo/rest-api/routes.json around until we have decided to disable v0

Ollie.Shotton_WMDE claimed this task.Oct 30 2024, 10:10 AM

Ollie.Shotton_WMDE moved this task from To Do to Doing on the Wikibase Reuse Team (Sprint 32) board.

Change #1085455 had a related patch set uploaded (by Ollie Shotton; author: Ollie Shotton):

[mediawiki/extensions/Wikibase@master] REST: Create REST API v1 release and enable with Wikibase extension

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

gerritbot added a project: Patch-For-Review.Oct 31 2024, 5:53 PM

Ollie.Shotton_WMDE moved this task from Doing to Peer Review on the Wikibase Reuse Team (Sprint 32) board.Nov 1 2024, 1:00 PM

Ollie.Shotton_WMDE moved this task from Peer Review to Done on the Wikibase Reuse Team (Sprint 32) board.Nov 1 2024, 2:47 PM

Change #1085455 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Create REST API v1 release and enable with Wikibase extension

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

Maintenance_bot removed a project: Patch-For-Review.Nov 1 2024, 3:30 PM

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.2; 2024-11-05).Nov 1 2024, 5:00 PM

Change #1089794 had a related patch set uploaded (by Ollie Shotton; author: Ollie Shotton):

[mediawiki/extensions/Wikibase@REL1_43] REST: Create REST API v1 release and enable with Wikibase extension

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

gerritbot added a project: Patch-For-Review.Nov 11 2024, 2:44 PM

Ifrahkhanyaree_WMDE closed this task as Resolved.Nov 12 2024, 10:21 AM

Ifrahkhanyaree_WMDE closed subtask T378455: Change REST API from v0 to v1 as Resolved.

Ifrahkhanyaree_WMDE moved this task from Next to Done on the Wikibase REST API (WPP) board.Nov 12 2024, 11:47 AM

Change #1089794 merged by jenkins-bot: