Page MenuHomePhabricator
Create Task
Maniphest T389409

Release REST API Sandbox on all remaining wikis
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

Description

Over the course of this quarter, we implemented multi-lingual support for REST API documentation through the REST Sandbox special page. In https://phabricator.wikimedia.org/T389407, we launched the sandbox to an initial set of friendly wiki communities that already had translations in place from translatewiki. The scope of this ticket is to make the REST API sandbox available on all remaining wiki projects, following a ~2 week soak period on the initial set of wikis. We hope to use the soak period to allow the communities to provide feedback about the new experience.

Conditions of acceptance

  • Enable the REST API Sandbox on all remaining wikis.
  • Announce full launch on WikiTech News
  • Announce full launch on wikitech-l distro
Implementation details

Sandbox enablement requires a config change.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Enable REST Sandbox on all wikisoperations/mediawiki-configmaster+5 -146
Customize query in gerrit

Related Objects
Search...

Event Timeline

HCoplin-WMF created this task.Mar 19 2025, 7:17 PM
HCoplin-WMF moved this task from MWI-Roadmap to Next Up on the MW-Interfaces-Team board.
HCoplin-WMF edited projects, added MW-Interfaces-Team; removed MW-Interfaces-Team (MWI-Roadmap).
HCoplin-WMF triaged this task as Medium priority.Mar 20 2025, 3:23 PM
HCoplin-WMF set the point value for this task to 2.
HCoplin-WMF moved this task from Next Up to MWI-Sprint-15 (2025-07-29 to 2025-08-12) on the MW-Interfaces-Team board.Jul 29 2025, 3:25 PM
HCoplin-WMF edited projects, added MW-Interfaces-Team (MWI-Sprint-15 (2025-07-29 to 2025-08-12)); removed MW-Interfaces-Team.
HCoplin-WMF mentioned this in T400629: REST Sandbox Global Enablement.
OWresch-WMF edited projects, added MW-Interfaces-Team (MW-Interfaces-Team (MWI-Sprint-16 (2025-08-12 to 2025-08-26))); removed MW-Interfaces-Team (MWI-Sprint-15 (2025-07-29 to 2025-08-12)).Aug 12 2025, 2:56 PM
OWresch-WMF edited projects, added MW-Interfaces-Team (MWI-Sprint-17 (2025-08-26 to 2025-09-09)); removed MW-Interfaces-Team (MW-Interfaces-Team (MWI-Sprint-16 (2025-08-12 to 2025-08-26))).Aug 26 2025, 3:26 PM
OWresch-WMF edited projects, added MW-Interfaces-Team (MWI-Sprint-18 (2025-09-09 to 2025-09-23)); removed MW-Interfaces-Team (MWI-Sprint-17 (2025-08-26 to 2025-09-09)).Sep 9 2025, 3:14 PM
BPirkle moved this task from Committed to Blocked on the MW-Interfaces-Team (MWI-Sprint-18 (2025-09-09 to 2025-09-23)) board.Sep 23 2025, 1:45 PM
HCoplin-WMF edited projects, added MW-Interfaces-Team (MWI-Sprint-19 (2025-09-23 to 2025-10-07)); removed MW-Interfaces-Team (MWI-Sprint-18 (2025-09-09 to 2025-09-23)).Sep 23 2025, 10:17 PM
HCoplin-WMF moved this task from Committed to Blocked on the MW-Interfaces-Team (MWI-Sprint-19 (2025-09-23 to 2025-10-07)) board.
OWresch-WMF edited projects, added MW-Interfaces-Team (MWI-Sprint-20 (2025-10-07 to 2025-10-21)); removed MW-Interfaces-Team (MWI-Sprint-19 (2025-09-23 to 2025-10-07)).Oct 7 2025, 3:10 PM
OWresch-WMF moved this task from Committed to Blocked on the MW-Interfaces-Team (MWI-Sprint-20 (2025-10-07 to 2025-10-21)) board.
BPirkle claimed this task.EditedOct 15 2025, 4:17 PM
BPirkle added subscribers: aaron, BPirkle.

Per discussion outside of Phabricator, we will initially enable the following specs on all wikis:

  • "MediaWiki REST API (routes not in modules)" aka "flat routes" aka "routes in coreRoutes.json"
    • available on all wikis
    • spec url: /w/rest.php/specs/v0/module/-
  • Specs module
    • will be made available on all wikis as part of this change (via wgRestAPIAdditionalRouteFiles)
    • spec url: /w/rest.php/specs/v0/module/specs/v0
    • provides an example of exposing a module via the REST Sandbox
    • the urls provided by this module will be visible as part of exposing the coreRoutes.json endpoints, and it is already visible on our initial set of wikis. So it seems a little silly to not put this in the sandbox everywhere too.
  • "Wikimedia RESTbase APIs" aka the specs created under T396805: Define static OpenAPI specs per API family for RESTbase endpoints
    • rerouting is complete for these specs
    • spec url: /api/rest_v1/?spec

We could also enable this, but per discussion outside Phabricator we will not initially do so. Maybe in a followup.

  • Reading Lists
    • available on wikis where wmgUseReadingLists is true
    • provides an example of enabling apis from extensions in the REST Sandbox, for other teams to follow
    • spec url: /rest.php/specs/v0/module/readinglists/v0

There are a few other extensions that could also be included but I'd prefer to let the owning teams add them.

The above lists does not apply to beta, which enabled a slightly different set of specs. Beta currently enables:

  • MediaWiki REST API
  • Specs API
  • Content API

That won't change. However, because of a longstanding typo I just noticed, "Specs API" has not been available in the REST Sandbox dropdown on beta (only, it worked fine on the other wikis that were part of the initial set). I will fix that, thereby making "Specs API" available in the dropdown on beta.

Subscribing @aaron because he worked extensively on the RESTbase spec rerouting.

BPirkle moved this task from Blocked to In Progress on the MW-Interfaces-Team (MWI-Sprint-20 (2025-10-07 to 2025-10-21)) board.Oct 15 2025, 4:18 PM
gerritbot added a comment.Oct 15 2025, 4:41 PM

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

[operations/mediawiki-config@master] Enable REST Sandbox on all wikis

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

gerritbot added a project: Patch-For-Review.Oct 15 2025, 4:41 PM
BPirkle moved this task from In Progress to Code Review on the MW-Interfaces-Team (MWI-Sprint-20 (2025-10-07 to 2025-10-21)) board.Oct 16 2025, 1:56 PM
gerritbot added a comment.Oct 20 2025, 1:45 PM

Change #1196492 merged by jenkins-bot:

[operations/mediawiki-config@master] Enable REST Sandbox on all wikis

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

Stashbot added a comment.Oct 20 2025, 1:46 PM

Mentioned in SAL (#wikimedia-operations) [2025-10-20T13:46:46Z] <lucaswerkmeister-wmde@deploy2002> Started scap sync-world: Backport for [[gerrit:1196492|Enable REST Sandbox on all wikis (T389409)]], [[gerrit:1192913|Growth: remove no longer in use GENewcomerTasksStarterDifficultyEnabled (T396382)]], [[gerrit:1196857|MetricsPlatform: Initialize $wgMetricsPlatformExperimentStreamNames (T406332)]], [[gerrit:1196703|Enable Special:EditWatchlist pagination on beta (T41510)]]

Stashbot mentioned this in T41510: Opening Special:EditWatchlist with a large watchlist hits server timeout (Create watchlist pager).Oct 20 2025, 1:46 PM
Stashbot mentioned this in T406332: Make XLAB_STREAMS allowlist configurable.
Stashbot mentioned this in T396382: Deployment Plan: Allow limiting "Add a Link" to new editors.
Stashbot added a comment.Oct 20 2025, 1:51 PM

Mentioned in SAL (#wikimedia-operations) [2025-10-20T13:51:18Z] <lucaswerkmeister-wmde@deploy2002> sgimeno, bpirkle, phuedx, lucaswerkmeister-wmde, cparle: Backport for [[gerrit:1196492|Enable REST Sandbox on all wikis (T389409)]], [[gerrit:1192913|Growth: remove no longer in use GENewcomerTasksStarterDifficultyEnabled (T396382)]], [[gerrit:1196857|MetricsPlatform: Initialize $wgMetricsPlatformExperimentStreamNames (T406332)]], [[gerrit:1196703|Enable Special:EditWatchlist paginati

Stashbot added a comment.Oct 20 2025, 2:02 PM

Mentioned in SAL (#wikimedia-operations) [2025-10-20T14:02:31Z] <lucaswerkmeister-wmde@deploy2002> Finished scap sync-world: Backport for [[gerrit:1196492|Enable REST Sandbox on all wikis (T389409)]], [[gerrit:1192913|Growth: remove no longer in use GENewcomerTasksStarterDifficultyEnabled (T396382)]], [[gerrit:1196857|MetricsPlatform: Initialize $wgMetricsPlatformExperimentStreamNames (T406332)]], [[gerrit:1196703|Enable Special:EditWatchlist pagination on beta (T41510)]] (duration

Maintenance_bot removed a project: Patch-For-Review.Oct 20 2025, 2:31 PM
BPirkle added a comment.Oct 20 2025, 3:05 PM

The REST Sandbox is now available on all wikis, with the following initial set of modules:

  • flat routes (routes not in modules) in coreRoutes.json
  • flat routes (routes not in modules) in various extensions
  • Specs module

Additional modules (ex. Reading Lists) can be added over time. We expect to add RESTbase specs soon, per T396805: Define static OpenAPI specs per API family for RESTbase endpoints.

BPirkle moved this task from Code Review to Demo Ready! on the MW-Interfaces-Team (MWI-Sprint-20 (2025-10-07 to 2025-10-21)) board.Oct 20 2025, 5:46 PM
OWresch-WMF edited projects, added MW-Interfaces-Team (MWI-Sprint-21 (2025-10-21 to 2025-11-04)); removed MW-Interfaces-Team (MWI-Sprint-20 (2025-10-07 to 2025-10-21)).Oct 22 2025, 3:12 PM
OWresch-WMF moved this task from Committed to Demo Ready! on the MW-Interfaces-Team (MWI-Sprint-21 (2025-10-21 to 2025-11-04)) board.
BPirkle closed this task as Resolved.Nov 4 2025, 3:47 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