Page MenuHomePhabricator
Create Task
Maniphest T193630

API automatic documentation should specify parameters that are added by extensions
Closed, DeclinedPublic
Actions

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 .

Related Objects

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
Aklapper added a project: Documentation.May 2 2018, 2:03 PM
Anomie moved this task from Unsorted to Non-core-API stuff on the MediaWiki-Action-API board.May 3 2018, 1:49 PM
Anomie subscribed.

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.
Anomie added a project: MobileFrontend.May 3 2018, 1:50 PM
Jdlrobson added a project: Web-Team-Backlog (Tracking).May 3 2018, 9:48 PM
• 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 added projects: CheckUser, Connected-Open-Heritage-Batch-uploads (RAÄ-KMB_1_2017-02), Tamil-Sites, Gamepress, Hashtags, Jade, KartoEditor, Language-2018-Apr-June, New-Editor-Experiences, Mail, TCB-Team (now WMDE-TechWish).
• 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.Jul 1 2018, 9:02 AM
CommunityTechBot updated the task description. (Show Details)
CommunityTechBot removed projects: TCB-Team (now WMDE-TechWish), Mail, New-Editor-Experiences, Language-2018-Apr-June, KartoEditor, Jade, Hashtags, Gamepress, Tamil-Sites, Connected-Open-Heritage-Batch-uploads (RAÄ-KMB_1_2017-02), CheckUser.
CommunityTechBot added a subscriber: Aklapper.
CommunityTechBot raised the priority of this task from High to Needs Triage.Jul 3 2018, 1:59 AM
• srodlund moved this task from Backlog to API Documentation Request on the Documentation board.Aug 14 2018, 11:12 PM
Jdlrobson removed a project: MobileFrontend.Jul 24 2020, 3:04 PM
Jdlrobson subscribed.

Untagged MobileFrontend per our plan to remove this API T186627

Restricted Application added a project: Platform Engineering. · View Herald TranscriptJul 24 2020, 3:04 PM
• AMooney removed a project: Platform Engineering.Jul 28 2020, 8:33 PM
• AMooney subscribed.

Is there any work to be done here if the api is being removed.

Jdlrobson closed this task as Declined.Jul 28 2020, 8:37 PM
Jdlrobson removed a project: Web-Team-Backlog (Tracking).

@AMooney I would guess not. API maintainers - feel free to reopen if not.

Declining in favor of T186627.

Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:28 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