Page MenuHomePhabricator

REST: publish ReadingLists v0 module in the REST Sandbox
Open, MediumPublic2 Estimated Story Points

Description

The ReadingLists extension has had a REST module since 2024 (implemented under T369763: Reading Lists: create REST module). However, that module was never published to the REST Sandbox.

Publish the module on the metawiki REST Sandbox. (Because Reading Lists works across all projects, it is unnecessary and perhaps confusing to enable it across all wikis where the extension is enabled, so at least for now we're starting with just meta.)

Event Timeline

BPirkle triaged this task as Medium priority.Mar 10 2026, 10:05 PM
BPirkle moved this task from Incoming (Needs Triage) to Backlog on the MW-Interfaces-Team board.
HCoplin-WMF raised the priority of this task from Medium to Needs Triage.Tue, Mar 24, 3:37 AM
HCoplin-WMF set the point value for this task to 2.

Since the module has existed for a long time, we can probably edit InitialiseSettings.php instead of CommonSettings.php. I might go and clean up some of the of the other CommonSettings entries (e.g. GrowthExperiments) now that the modules have been defined for several wmf branches now.

Change #1264856 had a related patch set uploaded (by KineticPelagic; author: KineticPelagic):

[operations/mediawiki-config@master] REST: Publish ReadingLists v0 module in REST Sandbox

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

Since the module has existed for a long time, we can probably edit InitialiseSettings.php instead of CommonSettings.php. I might go and clean up some of the of the other CommonSettings entries (e.g. GrowthExperiments) now that the modules have been defined for several wmf branches now.

@aaron , thank you for your input. I met with @BPirkle and, in this initial patch, made the change inside the if ( $wmgUseReadingLists ) conditional in CommonSettings.php to make sure that if the ReadingLists extension loads, then the REST Sandbox Spec loads. This initial approach accounts for a scenario in which a developer changes the wikis that map to $wmgUseReadingLists, say by adding wikis via the code block here, but forgets to add those wikis to relevant code within this block, and we still want the REST Sandbox Spec to load if and only if the ReadingLists extension loads.

It is interesting though to think through the benefit of a declarative $wgRestSandboxSpecs definition in InitialiseSettings.php so please let me know your feedback.

@Jdforrester-WMF also suggested InitialiseSettings.php, via (probably) +readinglists or maybe +sul. (See gerrit comment on the patch).

I did not see any other usage of +sul in InitialiseSettings.php, so I'd hesitated to do that. It sounds like it'd work, though, so that'd be better than CommonSettings.php in this case.

However, James also suggested +readinglists, which would be even better. But I have even less confidence that I understand how that actually works. I see us using +growthexperiments but I also see a lot of machinery in the config repo related to growthexperiments. For example:

I don't see that same machinery for readinglists. Would we need to add it?

If we would need to add all that, I'm tempted to use +sul for the current patch - the RestSandboxSettings config variable may be be refactored soon anyway as part of T413443: [5.2.8 Epic] Include Audience designations on modules.

Alternatively, we could just enable ReadingLists in the REST Sandbox on meta. It's a cross-project extension anyway - having it on each wiki doesn't gain you much - so that might even be more appropriate. I'd still like to understand the above better, though, because it is bound to come up again.

Sorry, there's not a readinglists dblist (yet); +sul should work, however.

Thanks James.

After further discussion, we're going to enable this for just metawiki, at least for now. We can add others later if desired, but it may prove unnecessary.

Change #1264856 merged by jenkins-bot:

[operations/mediawiki-config@master] REST: Publish ReadingLists v0 module in REST Sandbox

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

Mentioned in SAL (#wikimedia-operations) [2026-04-07T20:44:01Z] <cscott@deploy1003> Started scap sync-world: Backport for [[gerrit:1268635|Bump jawiki to 100% Parsoid Read Views (from 10%) (T420273)]], [[gerrit:1264856|REST: Publish ReadingLists v0 module in REST Sandbox (T419619)]], [[gerrit:1268225|Move createwithcontentmodel to autoconfirmed (T248294)]]

Mentioned in SAL (#wikimedia-operations) [2026-04-07T20:48:01Z] <cscott@deploy1003> cscott, pppery, kineticpelagic: Backport for [[gerrit:1268635|Bump jawiki to 100% Parsoid Read Views (from 10%) (T420273)]], [[gerrit:1264856|REST: Publish ReadingLists v0 module in REST Sandbox (T419619)]], [[gerrit:1268225|Move createwithcontentmodel to autoconfirmed (T248294)]] synced to the testservers (see https://wikitech.wikimedia.org/wiki/Mwdebug). Changes can now be verified there.

Mentioned in SAL (#wikimedia-operations) [2026-04-07T20:57:28Z] <cscott@deploy1003> Finished scap sync-world: Backport for [[gerrit:1268635|Bump jawiki to 100% Parsoid Read Views (from 10%) (T420273)]], [[gerrit:1264856|REST: Publish ReadingLists v0 module in REST Sandbox (T419619)]], [[gerrit:1268225|Move createwithcontentmodel to autoconfirmed (T248294)]] (duration: 13m 27s)