<API Platform> Documentation for API Platform Value Stream Team
Open, HighPublic
Actions

Assigned To

None

Authored By

	• VirginiaPoundstone
	Sep 13 2022, 4:34 PM

Description

Background/Goal

Create centralized documentation for the API platform team that is accessible and serves as a single source of truth.

User stories

As a product manager, I need a knowledge hub that serves as the single source of truth, so I can keep myself, the team, and stakeholders up to date, accountable, and informed.
As a member of the API Platform team, I need a knowledge hub that is updated weekly, so that I understand our team’s scope, health, and can find relevant links and information easily.
As a member of the WMF staff and/or open knowledge community, I want documentation that is complete, up to date, and easy to access and understand, so that I can learn about the API Platform team’s goals, progress, and ways I can contribute.

Related Objects
Search...

Status	Assigned	Task
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
Resolved	• EChetty	T285561 API Usage Metrics
Open	None	T333217 Service & API product monitoring instrumentation
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	T284579 [REQUEST] Data for external API Requests. Harden API Gateway
Declined	nettrom_WMF	T329907 [REQUEST] Analysis of available data on clients calling individual services through RESTbase
Open	None	T332864 [Needs grooming] Turnilo: include authentication status in request data cube
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
Resolved	• VirginiaPoundstone	T319693 Improve API Platform's Phabricator workboard(s)
Invalid	None	T328938 Migrate API Value Stream Team info to a wiki knowledge hub
Resolved	• VirginiaPoundstone	T317683 Create Roadmap for API Platform Team
Resolved	• VirginiaPoundstone	T317684 Establish OKRs for API Platform
Resolved	BPirkle	T321583 Tech lead review of drafted OKRs for API Platform Team
Resolved	Atieno	T321584 Engineering Manager review and feedback of drafted OKRs
Resolved	• VirginiaPoundstone	T321585 API Platform Team OKR review and feedback
Resolved	• VirginiaPoundstone	T321576 Workshop API Platform Roadmap with team
Resolved	BPirkle	T321580 Tech Lead review of API Platform Roadmap
Resolved	• VirginiaPoundstone	T317685 Recreate lost diagram of OAuths flow
Declined	• VirginiaPoundstone	T323008 Create AQS 2.0 on wiki one-pager
Open	None	T324024 Create a MediaWiki Project Page for API Platform

Event Timeline

• VirginiaPoundstone created this task.Sep 13 2022, 4:34 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 13 2022, 4:34 PM

• VirginiaPoundstone updated the task description. (Show Details)Sep 13 2022, 4:35 PM

• VirginiaPoundstone updated the task description. (Show Details)

• VirginiaPoundstone added a project: Epic.Sep 13 2022, 4:39 PM

• VirginiaPoundstone moved this task from Must do now to Backlog on the API Platform board.

Aklapper added a project: Documentation.Sep 13 2022, 4:43 PM

Review and update Phab board details.

Screen Shot 2022-09-13 at 12.42.52 PM.png (1×1 px, 350 KB)

• VirginiaPoundstone moved this task from Backlog to API Platform Roadmap on the API Platform board.Sep 13 2022, 5:08 PM

• VirginiaPoundstone edited projects, added API Platform (API Platform Roadmap); removed API Platform.

• VirginiaPoundstone triaged this task as High priority.Sep 13 2022, 6:23 PM

• VirginiaPoundstone moved this task from Backlog to Develop on the API Platform (API Platform Roadmap) board.Sep 15 2022, 5:07 PM

• VirginiaPoundstone closed subtask T317685: Recreate lost diagram of OAuths flow as Resolved.Sep 20 2022, 3:20 PM

• VirginiaPoundstone closed subtask T317677: Update API Platform Phab description and links as Resolved.Sep 26 2022, 1:43 PM

• VirginiaPoundstone closed subtask T317683: Create Roadmap for API Platform Team as Resolved.Oct 25 2022, 3:29 PM

• VirginiaPoundstone reopened subtask T317683: Create Roadmap for API Platform Team as In Progress.Oct 25 2022, 7:34 PM

• VirginiaPoundstone renamed this task from Create documentation for API Platform Team to <API Platform> Documentation for API Platform Value Stream Team.Nov 14 2022, 6:56 PM

• VirginiaPoundstone added a subtask: T323008: Create AQS 2.0 on wiki one-pager.Nov 16 2022, 9:18 PM

• VirginiaPoundstone added a subtask: T324024: Create a MediaWiki Project Page for API Platform.Nov 29 2022, 2:50 PM

• VirginiaPoundstone mentioned this in T326698: Write One-Pager PRD for Harden API Gateway.Jan 11 2023, 2:23 AM

• VirginiaPoundstone mentioned this in T326701: Draft Diagrams of current state of API ecosystem.Jan 11 2023, 2:38 AM

JArguello-WMF closed subtask T317683: Create Roadmap for API Platform Team as Resolved.Feb 1 2023, 6:58 PM

JArguello-WMF closed subtask T323008: Create AQS 2.0 on wiki one-pager as Declined.Apr 5 2023, 8:46 PM

• VirginiaPoundstone removed • VirginiaPoundstone as the assignee of this task.Oct 6 2023, 4:22 PM