Page MenuHomePhabricator
Create Task
Maniphest T426852

Create user guide for how to register an externally managed API so that it is surfaced in the REST Sandbox
Open, In Progress, MediumPublic3 Estimated Story Points
Actions

Description

Description

We support a wide variety of APIs, including some that are built and managed outside of MediaWiki. In these cases, we would still like to make the APIs discoverable through centralized means. We therefore support a "bring your own spec" style workflow, which API maintainers with externally built APIs can utilize to display their APIs alongside those built and managed from within MediaWiki.

Conditions of acceptance

  • Create a user guide that outlines how to register a pre-defined, externally managed OpenAPI spec so that it appears within the REST Sandbox
  • Outline the pre-requisites, in terms of expected spec version and expectations for pulling from a dedicated endpoint
  • Include guidelines for consistent naming conventions, for how it will appear in the dropdown
  • Include instructions for how to adjust the presentation order within the dropdown
  • Review the guide with the team
  • Publish guide to MediaWiki

Details

Due Date
Tue, Jul 28, 7:00 AM

Related Objects
Search...

Event Timeline

HCoplin-WMF created this task.May 20 2026, 1:15 PM
HCoplin-WMF mentioned this in T418196: [5.2.8 Epic]: REST API Framework Documentation.
HCoplin-WMF moved this task from Incoming (Needs Triage) to To Estimate on the MediaWiki-API-Platform-Team board.May 20 2026, 2:34 PM
HCoplin-WMF set the point value for this task to 3.May 21 2026, 3:35 PM

Notes from estimation:

  • This will likely become irrelevant once external modules are available (phab task TBD)
HCoplin-WMF moved this task from To Estimate to Ready, Sized, & Prioritized on the MediaWiki-API-Platform-Team board.May 27 2026, 3:32 PM
HCoplin-WMF triaged this task as Medium priority.Jun 2 2026, 1:19 PM
BPirkle moved this task from Ready, Sized, & Prioritized to MWI-Sprint-36 (2026-06-16 to 2026-06-30) on the MediaWiki-API-Platform-Team board.Jun 16 2026, 2:54 PM
BPirkle edited projects, added: MediaWiki-API-Platform-Team (MWI-Sprint-36 (2026-06-16 to 2026-06-30)); removed: MediaWiki-API-Platform-Team.
HCoplin-WMF edited projects, added: MediaWiki-API-Platform-Team (MediaWiki-Interfaces-Sprints); removed: MediaWiki-API-Platform-Team (MWI-Sprint-36 (2026-06-16 to 2026-06-30)).Tue, Jun 30, 3:22 PM
BPirkle removed BPirkle as the assignee of this task.Thu, Jul 2, 7:50 PM
BPirkle subscribed.
OWresch-WMF assigned this task to ArielGlenn.Tue, Jul 14, 4:07 PM
aaron set Due Date to Tue, Jul 28, 7:00 AM.Tue, Jul 14, 6:47 PM
ArielGlenn changed the task status from Open to In Progress.Wed, Jul 22, 1:39 AM
ArielGlenn moved this task from Committed to In Progress on the MediaWiki-API-Platform-Team (MediaWiki-Interfaces-Sprints) board.
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