Page MenuHomePhabricator

Move Link Recommendation API docs off the API Portal
Closed, ResolvedPublic

Description

As part of the work to sunset the API Portal, we need to move the Link Recommendation API docs to a new location. This will likely be an intermediate step as part of the overall API standardization work, but moving this content to a new location in the short term will help unblock the API Portal sunset work.

Content:

Recommendation for new locations:

To do:

  • Ensure all information from the API Portal docs is present in https://api.wikimedia.org/service/linkrecommendation/apidocs/ @apaskulin
  • Decide on new location for landing page
  • Create the new landing page
  • Update all links pointing to the API Portal docs
  • [Added banners, waiting until March 2026 to fully redirect content] Redirect API Portal docs to the new locations

Out of scope for this task:

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Hi Growth Team! I'd like to put this on your radar for this quarter. I'm happy to do the actual content migration if your team can be available for reviews and feedback. I think https://wikitech.wikimedia.org/wiki/Add_Link/API https://www.mediawiki.org/wiki/Link_Recommendation_API would be a good location for a new landing page for the API, but let me know what you think or if you have any ideas!

Edit: As part of the overall API standardization work in WE5.2, we're recommending all API landing pages be on mediawiki.org, so I've changed the recommended new location to reflect this.

Change #1233279 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[research/mwaddlink@main] docs: Match style and content of API Portal docs

https://gerrit.wikimedia.org/r/1233279

Change #1233279 merged by jenkins-bot:

[research/mwaddlink@main] docs: Match style and content of API Portal docs

https://gerrit.wikimedia.org/r/1233279

Change #1236780 had a related patch set uploaded (by Urbanecm; author: Urbanecm):

[operations/deployment-charts@master] linkrecommendation: Bump version

https://gerrit.wikimedia.org/r/1236780

Change #1236780 merged by jenkins-bot:

[operations/deployment-charts@master] linkrecommendation: Bump version

https://gerrit.wikimedia.org/r/1236780

Nice find! I updated the interface link on that page. Do you think it would be good to link to that page from the API docs?

Yes, I think so, especially since that's the existing pattern for all the Lift Wing API docs and their corresponding model cards.

I also noticed that links in the README at https://gerrit.wikimedia.org/g/research/mwaddlink should be updated to reflect new doc locations, and there's currently a link to https://wikitech.wikimedia.org/wiki/Add_Link which may or may not be in scope for these doc updates

Updates to https://wikitech.wikimedia.org/wiki/Add_Link are out of scope, but I did update the link to the API Portal there. Nice find on the README! I'll update one of the links there to point to the wiki page. The "production URL for the Swagger docs" will remain valid until the endpoints themselves are deprecated and re-routed.

Change #1249412 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[research/mwaddlink@main] docs: Link to new API docs landing page

https://gerrit.wikimedia.org/r/1249412

Change #1249412 merged by jenkins-bot:

[research/mwaddlink@main] docs: Link to new API docs landing page

https://gerrit.wikimedia.org/r/1249412

apaskulin updated the task description. (Show Details)