Page MenuHomePhabricator

Document mapping between Special Pages and API modules
Open, LowPublic

Description

It'd be nice to have some sort of canonical resource (or maybe even self documented in MW/the API in some way/a link on the special page) of the mappings between how you can get the machine representation of a special page via the API (potentially even the traditional API and the newer Rest API)

Having it in MW itself would allow extensions to list their own mappings and have those included tooo

Event Timeline

Reedy created this task.Dec 2 2019, 7:03 PM
Restricted Application added a project: Core Platform Team. · View Herald TranscriptDec 2 2019, 7:03 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
Anomie added a subscriber: Anomie.

The easiest and most flexible thing might be to just add the information to the existing on-wiki help pages linked from the special pages and Action API auto-generated docs, e.g. https://www.mediawiki.org/wiki/Help:New_files and https://www.mediawiki.org/wiki/API:Allimages for the pair mentioned in T239639.

Such notes could also be added to the API modules' extended-description doc messages, e.g. https://www.mediawiki.org/wiki/MediaWiki:Apihelp-query+allimages-extended-description, if that seems appropriate.

I'm unsure whether there's often enough a 1:1 mapping that doing it in some more structured manner would work out in practice. That would take some investigation to collect the mappings and find out.

WDoranWMF triaged this task as Low priority.Dec 4 2019, 7:54 PM
WDoranWMF moved this task from Triage Meeting Inbox to Icebox on the Core Platform Team board.