Page MenuHomePhabricator

Plan shutdown process for the API Portal
Open, MediumPublic

Description

In order to shut down the API Portal, we need to create a plan and timeline for shutting down the wiki and related components.

Components

Goal

Our goal is to no longer run the API Portal and related components in WMF beta and production. Visiting any https://api.wikimedia.org/wiki/ URL should redirect to a TBD wiki page.

Strategy discussion

Based on wikitech:Delete a wiki, it seems that the usual process is to close a wiki instead of delete it. However, there is precedence for wikis being deleted in the past, such as Sep11wiki where the content was partially merged with Wikipedia and retained in the Internet Archive and Wikimedia Dumps. I think the API Portal is a similar type of content where the wiki is being superseded by other content locations.

Options for retaining content long term:

Timeline

Work in progress

  • January 22, 2026: Initial announcement
  • January-April 2026: @apaskulin completes content migration
  • June 2026:
    • ServiceOps redirects all API Portal URLs (http://api.wikimedia.org/wiki/) to https://www.mediawiki.org/wiki/Wikimedia_APIs T418492
    • ServiceOps deletes the API Portal wiki T418492
    • MediaWiki Interfaces undeploys Skin:WikimediaApiPortal
    • MediaWiki Interfaces undeploys Extension:WikimediaApiPortalOAuth

To do

Q3:

  • Review the timeline for feasibility, and whether there are other options we should consider. (See the strategy discussion section)
  • Check with Data Platform Engineering on whether it would be feasible to offer a dump of the API Portal wiki long term, and what actions would be needed to do that.
    • From the docs on Meta: "Deleted wikis no longer have current dumps generated, but the last old dump is usually still around." However, the last dump of the API Portal wouldn't be very useful since the content will have been migrated elsewhere at that point. The last useful dump would be the last dump from 2025. There are several dumps in the Internet Archive, so we can direct users to those if it's not feasible to keep a specific historical dump.

Q4:

  • Complete the steps in the timeline to sunset the wiki

Event Timeline

Hi ServiceOps new! Would someone be available to work with me on this in Q3 and Q4? This is the starting point for the API Portal deprecation, related to the API Gateway deprecation

@Clement_Goubert could you PTAL and confirm when this could start and who can be the POC?

jijiki moved this task from Inbox to Scheduled (this Q) on the ServiceOps new board.
Clement_Goubert added a subscriber: HCoplin-WMF.

ServiceOps triage:

  • Tagging ServiceOps-SharedInfra as it's related to rest-gateway work
  • Setting to Needs info and scheduling a meeting with @HCoplin-WMF and @apaskulin to gather more info about what is expected from ServiceOps and when. First approximation is actualy work for us would be to actually put the wiki in RO and then close, which would happen in Q4.

Thanks for looking at this, @Clement_Goubert! Looks like there's a meeting scheduled for next week, but in the meantime, I added some details to the task with specific questions for ServiceOps

Clement_Goubert moved this task from Scheduled (this Q) to Radar on the ServiceOps new board.

Moving to serviceops Radar as we have provided the required information.