Page MenuHomePhabricator
Create Task
Maniphest T422403

Create Wikibase v1 REST API Module
Closed, ResolvedPublic8 Estimated Story Points
Actions

Description

Description

The first step of making the Wikibase documentation more reasonable and consistent with our other API structures is to create an API module. API module creation will allow us to have flexibility with how and where the reference documentation is displayed. Specifically, we can contain and eventually hide the endpoints from the flat list to make it easier to navigate while opting to display the higher quality externally managed spec within the Sandbox.

Conditions of acceptance

  • Create a REST API module for the Wikibase extension
  • All routes under wikibase/v1 should be included in that module
  • Do not surface this module in the REST Sandbox; it should be hidden by default

EDIT: we will surface the sandbox for parity with what's there now since since can't yet use the open-api.json spec provided by one of the endpoints until T425451 is dealt with.
ANOTHER EDIT: we changed course and will not surface this module in the REST Sandbox at this time.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Introduce a REST module for /wikibase/v1 endpointsmediawiki/extensions/Wikibasemaster+891 -337
Revert "Add wikibase.v1 module to the sandbox were it is present"operations/mediawiki-configmaster+0 -8
Add wikibase.v1 module to the sandbox were it is presentoperations/mediawiki-configmaster+8 -0
rest: use getRoutePath() for metrics in Modulemediawiki/coremaster+7 -10
Customize query in gerrit

Related Objects
Search...

Event Timeline

HCoplin-WMF created this task.Apr 6 2026, 4:56 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 6 2026, 4:56 PM
HCoplin-WMF added a parent task: T422402: [5.2.8b Milestone] Onboard Wikibase as an API module and externally defined OAD spec.Apr 6 2026, 4:56 PM
HCoplin-WMF added projects: OKR-Work, MediaWiki-REST-API.
BPirkle triaged this task as Medium priority.Apr 6 2026, 6:54 PM
BPirkle moved this task from Incoming (Needs Triage) to Backlog on the MW-Interfaces-Team board.
HCoplin-WMF moved this task from Backlog to MWI-Sprint-31 (2026-04-07 to 2026-04-21) on the MW-Interfaces-Team board.Apr 7 2026, 3:10 AM
HCoplin-WMF edited projects, added: MW-Interfaces-Team (MWI-Sprint-31 (2026-04-07 to 2026-04-21)); removed: MW-Interfaces-Team.
aaron claimed this task.Apr 7 2026, 4:43 PM
aaron set the point value for this task to 8.
aaron moved this task from Committed to In Progress on the MW-Interfaces-Team (MWI-Sprint-31 (2026-04-07 to 2026-04-21)) board.Apr 10 2026, 12:34 AM
gerritbot added a comment.Apr 17 2026, 4:52 AM

Change #1273300 had a related patch set uploaded (by Aaron Schulz; author: Aaron Schulz):

[mediawiki/extensions/Wikibase@master] [DNM] Introduce a REST module for /wikibase/v1 endpoints

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

gerritbot added a project: Patch-For-Review.Apr 17 2026, 4:52 AM
HCoplin-WMF edited projects, added: MW-Interfaces-Team (MWI-Sprint-32 (2026-04-21 to 2026-05-05)); removed: MW-Interfaces-Team (MWI-Sprint-31 (2026-04-07 to 2026-04-21)).Apr 21 2026, 3:04 PM
HCoplin-WMF moved this task from Committed to In Progress on the MW-Interfaces-Team (MWI-Sprint-32 (2026-04-21 to 2026-05-05)) board.
HCoplin-WMF added a subscriber: Mooeypoo.Apr 21 2026, 3:07 PM

Next steps here: Confirm LoE for self-service security review so we can decide if the SwaggerUI upgrade is possible. @Mooeypoo & @aaron will lead the conversation and report back on options. The main issue is that we are confident we will move away from SwaggerUI within a few months, so we should not invest weeks of effort to go through a security review. If the self service process takes a day or two, then we can do it; if it will be weeks or months of turnaround time, then we will not be able to ingest the existing Wikidata spec and will need to discuss other options.

HCoplin-WMF mentioned this in T423973: Cleanup getRouteUrl() for module-based Handlers.Apr 21 2026, 3:19 PM
aaron moved this task from In Progress to Code Review on the MW-Interfaces-Team (MWI-Sprint-32 (2026-04-21 to 2026-05-05)) board.Apr 23 2026, 9:33 PM
gerritbot added a comment.Apr 23 2026, 9:48 PM

Change #1276814 had a related patch set uploaded (by Aaron Schulz; author: Aaron Schulz):

[operations/mediawiki-config@master] Add wikibase.v1 module to the sandbox were it is present

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

gerritbot added a comment.Apr 29 2026, 2:13 AM

Change #1278799 had a related patch set uploaded (by Aaron Schulz; author: Aaron Schulz):

[mediawiki/core@master] rest: use getRoutePath() for metrics in Module

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

aaron changed the task status from Open to In Progress.Apr 29 2026, 3:28 PM
WMDE-leszek subscribed.Apr 30 2026, 7:19 PM
OWresch-WMF edited projects, added: MW-Interfaces-Team (MWI-Sprint-33 (2026-05-05 to 2026-05-19)); removed: MW-Interfaces-Team (MWI-Sprint-32 (2026-04-21 to 2026-05-05)).May 5 2026, 3:04 PM
OWresch-WMF moved this task from Committed to Code Review on the MW-Interfaces-Team (MWI-Sprint-33 (2026-05-05 to 2026-05-19)) board.
gerritbot added a comment.May 5 2026, 8:11 PM

Change #1276814 merged by jenkins-bot:

[operations/mediawiki-config@master] Add wikibase.v1 module to the sandbox were it is present

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

Stashbot mentioned this in T424891: Enable WikiLove on shwiki.May 5 2026, 8:12 PM

Mentioned in SAL (#wikimedia-operations) [2026-05-05T20:11:59Z] <arlolra@deploy1003> Started scap sync-world: Backport for [[gerrit:1283082|Enable WikiLove on shwiki (T424891)]], [[gerrit:1276814|Add wikibase.v1 module to the sandbox were it is present (T422403)]]

Stashbot added a comment.May 5 2026, 8:13 PM

Mentioned in SAL (#wikimedia-operations) [2026-05-05T20:13:56Z] <arlolra@deploy1003> aaron, neriah, arlolra: Backport for [[gerrit:1283082|Enable WikiLove on shwiki (T424891)]], [[gerrit:1276814|Add wikibase.v1 module to the sandbox were it is present (T422403)]] synced to the testservers (see https://wikitech.wikimedia.org/wiki/Mwdebug). Changes can now be verified there.

Stashbot added a comment.May 5 2026, 8:22 PM

Mentioned in SAL (#wikimedia-operations) [2026-05-05T20:22:30Z] <arlolra@deploy1003> Finished scap sync-world: Backport for [[gerrit:1283082|Enable WikiLove on shwiki (T424891)]], [[gerrit:1276814|Add wikibase.v1 module to the sandbox were it is present (T422403)]] (duration: 10m 30s)

BPirkle subscribed.May 5 2026, 8:45 PM

The task description still says we're hiding this from the REST Sandbox. To confirm, given the swagger ui upgrade challenges, we decided to alter the original plan, will be publishing the spec in the REST Sandbox, and should update the task description, right? I note that the config change for publishing the generated spec to the REST Sandbox once the module is present is merged.

The change to create the REST module looks good pending tests passing (the one failure seems unrelated to the change - CI flakiness?)

aaron updated the task description. (Show Details)May 6 2026, 5:20 AM
gerritbot added a comment.May 11 2026, 2:17 AM

Change #1278799 merged by jenkins-bot:

[mediawiki/core@master] rest: use getRoutePath() for metrics in Module

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

ReleaseTaggerBot added a project: MW-1.47-notes (1.47.0-wmf.2; 2026-05-12).May 11 2026, 3:00 AM
BPirkle updated the task description. (Show Details)Wed, May 13, 4:29 PM

Update: we originally intended to not show this module in the REST Sandbox, and then decided to. After further consideration, we have returned to the original decision, and will not be showing this module in the REST Sandbox at this time.

The config change to show the module was merged, but the change to create module itself was never merged, so these is no visible effect from this decision. We'll revert the config change before merging the module change.

gerritbot added a comment.Wed, May 13, 4:32 PM

Change #1286981 had a related patch set uploaded (by BPirkle; author: BPirkle):

[operations/mediawiki-config@master] Revert "Add wikibase.v1 module to the sandbox were it is present"

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

gerritbot added a comment.Wed, May 13, 8:06 PM

Change #1286981 merged by jenkins-bot:

[operations/mediawiki-config@master] Revert "Add wikibase.v1 module to the sandbox were it is present"

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

Stashbot added a comment.Wed, May 13, 8:07 PM

Mentioned in SAL (#wikimedia-operations) [2026-05-13T20:06:59Z] <cjming@deploy1003> Started scap sync-world: Backport for [[gerrit:rMW12869819abdd|Revert "Add wikibase.v1 module to the sandbox were it is present" (T422403)]]

Stashbot added a comment.Wed, May 13, 8:09 PM

Mentioned in SAL (#wikimedia-operations) [2026-05-13T20:09:01Z] <cjming@deploy1003> bpirkle, cjming: Backport for [[gerrit:rMW12869819abdd|Revert "Add wikibase.v1 module to the sandbox were it is present" (T422403)]] synced to the testservers (see https://wikitech.wikimedia.org/wiki/Mwdebug). Changes can now be verified there.

Stashbot added a comment.Wed, May 13, 8:13 PM

Mentioned in SAL (#wikimedia-operations) [2026-05-13T20:13:46Z] <cjming@deploy1003> Finished scap sync-world: Backport for [[gerrit:rMW12869819abdd|Revert "Add wikibase.v1 module to the sandbox were it is present" (T422403)]] (duration: 06m 47s)

BPirkle added a comment.Thu, May 14, 2:12 PM

I think the patch for creating the module is ready to go in, and we have a +1.

Would anyone from WMDE like to take a look first? I wasn't sure who to tag as reviewer. @WMDE-leszek

HCoplin-WMF edited projects, added: MW-Interfaces-Team (MWI-Sprint-34 (2026-05-19 to 2026-06-02)); removed: MW-Interfaces-Team (MWI-Sprint-33 (2026-05-05 to 2026-05-19)).Tue, May 19, 2:49 PM
HCoplin-WMF moved this task from Committed to Code Review on the MW-Interfaces-Team (MWI-Sprint-34 (2026-05-19 to 2026-06-02)) board.
gerritbot added a comment.Tue, May 19, 3:03 PM

Change #1273300 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Introduce a REST module for /wikibase/v1 endpoints

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

Maintenance_bot removed a project: Patch-For-Review.Tue, May 19, 3:31 PM
BPirkle updated the task description. (Show Details)Tue, May 26, 3:17 PM
BPirkle moved this task from Code Review to Demo Ready! on the MW-Interfaces-Team (MWI-Sprint-34 (2026-05-19 to 2026-06-02)) board.
aaron closed this task as Resolved.Tue, Jun 2, 2:37 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits