Draft Diagrams of current state of API ecosystem
Open, MediumPublic
Actions

Assigned To

None

Authored By

	• VirginiaPoundstone
	Jan 11 2023, 2:38 AM

Description

Background/Goal

T326697: Harden API Gateway in preparation for RESTbase deprecation service migration needs to know what problems it is solving. In order to understand and communicate the problems clearly across stakeholders, we need to diagram the current state and point out pain points we will solve for.

Key Tasks/Dependencies

Review all existing documentation
Make rough diagrams request and traffic flow diagrams based on current documentation
Review rough diagrams with most relevant engineering stakeholders
Clean-up and refine diagrams
Publish final on wiki (T317673: <API Platform> Documentation for API Platform Value Stream Team API Platform's knowledge hub)

Related Objects
Search...

Status	Assigned	Task
Open	None	T317673 <API Platform> Documentation for API Platform Value Stream Team
Resolved	• VirginiaPoundstone	T317677 Update API Platform Phab description and links
Declined	• VirginiaPoundstone	T317678 Create MediaWiki Knowledge Hub Wiki for API Platform Team
Open	None	T319330 Document current WMF service usage across the WMF ecosystem
Open	None	T306043 <API Platform> API Gateway MVP
Open	None	T326697 Harden API Gateway in preparation for RESTbase deprecation service migration
Resolved	• VirginiaPoundstone	T326698 Write One-Pager PRD for Harden API Gateway
Open	None	T326701 Draft Diagrams of current state of API ecosystem
Declined	• VirginiaPoundstone	T318805 Collate various API Catalogs
Open	None	T285674 Baseline API Usage Metrics
Invalid	• VirginiaPoundstone	T320537 <spike> Usage and traffic data for WMF APIs
Open	None	T329419 Architect potential API Gateway Patterns in preparation for services migrated off RESTbase
Resolved	• VirginiaPoundstone	T329668 Figure out how to get data on clients calling individual services through RESTbase

Event Timeline

• VirginiaPoundstone created this task.Jan 11 2023, 2:38 AM

• VirginiaPoundstone triaged this task as High priority.

• VirginiaPoundstone moved this task from Next Up to Next Up on the API Platform (Sprint 03) board.Jan 11 2023, 3:08 AM

• VirginiaPoundstone added subtasks: T318805: Collate various API Catalogs, T285674: Baseline API Usage Metrics.Jan 11 2023, 6:36 PM

• VirginiaPoundstone moved this task from Next Up to In Progress on the API Platform (Sprint 03) board.Jan 12 2023, 2:04 PM

• VirginiaPoundstone moved this task from In Progress to Blocked/Paused on the API Platform (Sprint 03) board.Jan 19 2023, 12:27 AM

• VirginiaPoundstone moved this task from Blocked/Paused to In Progress on the API Platform (Sprint 03) board.Jan 19 2023, 1:57 PM

• VirginiaPoundstone moved this task from In Progress to Blocked/Paused on the API Platform (Sprint 03) board.Jan 23 2023, 2:09 PM

• VirginiaPoundstone renamed this task from Draft Diagrams of current state of services ecosystem to Draft Diagrams of current state of API ecosystem.Jan 30 2023, 7:04 PM

• VirginiaPoundstone updated the task description. (Show Details)

pmiazga subscribed.Jan 30 2023, 7:22 PM

• VirginiaPoundstone reassigned this task from • VirginiaPoundstone to pmiazga.Jan 31 2023, 11:03 PM

• VirginiaPoundstone edited projects, added API Platform (Sprint 05); removed API Platform (Sprint 03).

pmiazga added a project: WMF-Architecture-Team.Feb 6 2023, 6:28 PM

pmiazga moved this task from Inbox/Watching to Now on the WMF-Architecture-Team board.

Let me leave it as a note - for MediaWiki and Wikimedia we already have pretty good diagrams provided by @Krinkle

WMF Infrastructure: https://wikitech.wikimedia.org/wiki/File:WMF_infrastructure_2022.png
MediaWiki Infrastructure: https://wikitech.wikimedia.org/wiki/File:MediaWiki_infrastructure_2022.png
Wikipedia Request: https://upload.wikimedia.org/wikipedia/commons/4/4d/Wikipedia_webrequest_2022.png

@pmiazga I hope to get a more granular view of current state in terms of all endpoints request and traffic flows. At a similar information fidelity as this[[ https://miro.com/app/board/uXjVP0tyxwQ=/ | Thumbor diagram ]].

• VirginiaPoundstone lowered the priority of this task from High to Medium.Feb 11 2023, 9:34 AM

JArguello-WMF moved this task from Next Up to In Progress on the API Platform (Sprint 05) board.Feb 14 2023, 3:18 PM

JArguello-WMF closed subtask T318805: Collate various API Catalogs as Declined.Feb 24 2023, 12:39 AM

JArguello-WMF edited projects, added API Platform; removed API Platform (Sprint 05).Mar 28 2023, 6:27 PM

• VirginiaPoundstone moved this task from Incoming to Needs Grooming on the API Platform board.Mar 31 2023, 6:36 PM

• VirginiaPoundstone moved this task from Needs Grooming to Must do now on the API Platform board.Apr 17 2023, 2:26 PM

• VirginiaPoundstone added a parent task: T319330: Document current WMF service usage across the WMF ecosystem.Apr 17 2023, 3:16 PM

• VirginiaPoundstone moved this task from Must do now to Could do Next on the API Platform board.Apr 26 2023, 1:30 PM

@pmiazga: Removing task assignee as this open task has been assigned for more than two years - See the email sent on 2025-05-22.
Please assign this task to yourself again if you still realistically [plan to] work on this task - it would be welcome!
If this task has been resolved in the meantime, or should not be worked on by anybody ("declined"), please update its task status via "Add Action… 🡒 Change Status".
Also see https://www.mediawiki.org/wiki/Bug_management/Assignee_cleanup for tips how to best manage your individual work in Phabricator. Thanks!

Draft Diagrams of current state of API ecosystemOpen, MediumPublicActions