Page MenuHomePhabricator

API automatic documentation should specify parameters that are added by extensions
Open, Needs TriagePublic

Description

If I read the automatic documentation for action=parse on en.wp, I have no way of telling that the parameters "mobileformat", "noimages" and "mainpage" come from the extension MobileFrontend and that that portion of the API is unstable as indicated here: https://www.mediawiki.org/wiki/Extension:MobileFrontend#API .

Event Timeline

MER-C created this task.May 2 2018, 1:34 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 2 2018, 1:34 PM
Anomie added a subscriber: Anomie.

The API itself has no way to know this. MobileFrontend can do so in various ways, including

  • Mentioning this in each parameter's existing documentation message.
  • Using ApiBase::PARAM_HELP_MSG_INFO or ApiBase::PARAM_HELP_MSG_APPEND in the parameters' definitions to append a semi-standard message to each parameter's documentation.
Vvjjkkii renamed this task from API automatic documentation should specify parameters that are added by extensions to psdaaaaaaa.Jul 1 2018, 1:12 AM
Vvjjkkii triaged this task as High priority.
Vvjjkkii updated the task description. (Show Details)
Vvjjkkii removed a subscriber: Aklapper.
CommunityTechBot renamed this task from psdaaaaaaa to API automatic documentation should specify parameters that are added by extensions.
CommunityTechBot added a subscriber: Aklapper.
CommunityTechBot raised the priority of this task from High to Needs Triage.Jul 3 2018, 1:59 AM