Page MenuHomePhabricator
Create Task
Maniphest T306043

<API Platform> API Gateway MVP
Open, In Progress, HighPublic
Actions

Description

Related OKRs: 2021 - TI-CO-TCB

Request Title: API Gateway MVP

  • Request Description: Extend and enhance the API Gateway features and design to support requirements from API management strategy, which will unblock teams from adoption.
  • Indicate Priority Level: HIGH
  • Main Requestors: Chris Albon, Desiree Abad
  • Ideal Delivery Date: FY 2021 Q4
  • Stakeholders:

Request Documentation

Document TypeRequired?Document/Link
Product One PagerNosee strategy/management docs
Product Requirements Document (PRD)Yeshttps://docs.google.com/spreadsheets/d/174pZRPhdL9bMec-87Eho8HB5kV7Ua14fyrxuxoENoh4/edit#gid=0
Product RoadmapNoin progress
Product Planning/Business CaseNo<add link here>
Product BriefNo<add link here>
Other LinksNo<add links here>

Success Criteria

  • Critical Rate Limit Features Developed
    • API global rate limit - for all traffic hitting API
    • Key-level rate limit - for specific entity
    • Key level per API - combo of above types
    • Remove single global rate-limit currently in POC Gateway
  • Auth
      • Support via mediawiki
      • Call auth as a service
    • Establish Gateways to support different types of APIs
      • Open/Public
      • Partner
      • Internal

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenNoneT317673 <API Platform> Documentation for API Platform Value Stream Team
 ResolvedVirginiaPoundstoneT317677 Update API Platform Phab description and links
 DeclinedVirginiaPoundstoneT317678 Create MediaWiki Knowledge Hub Wiki for API Platform Team
 OpenNoneT319330 Document current WMF service usage across the WMF ecosystem
 In Progress• DAbadT306043 <API Platform> API Gateway MVP
ResolvedhnowlanT295956 Proposal: add a per-service rate limit setting to API Gateway
 Open• DAbadT299649 Limit problematic queries for WCQS
 OpenSpikeNoneT318096 <spike> Test Plan for API Gateway feature testing
 OpenNoneT326697 Harden API Gateway in preparation for RESTbase deprecation service migration
 ResolvedVirginiaPoundstoneT326698 Write One-Pager PRD for Harden API Gateway
 DeclinedVirginiaPoundstoneT323010 Draft project plan for API Infrastructure Collaboration
 OpenpmiazgaT326701 Draft Diagrams of current state of API ecosystem
 DeclinedVirginiaPoundstoneT318805 Collate various API Catalogs
 OpenVirginiaPoundstoneT285674 Baseline API Usage Metrics
 InvalidVirginiaPoundstoneT320537 <spike> Usage and traffic data for WMF APIs
 OpenpmiazgaT329419 Architect potential API Gateway Patterns in preparation for services migrated off RESTbase
 ResolvedVirginiaPoundstoneT329668 Figure out how to get data on clients calling individual services through RESTbase
 InvalidNoneT326699 Route Device Analytics through API Gateway
 ResolvedhnowlanT324130 Update API gateway to newer version of Envoy

Event Timeline

• DAbad created this task.Apr 13 2022, 3:35 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 13 2022, 3:35 PM
• DAbad changed the task status from Open to In Progress.Apr 13 2022, 3:43 PM
• DAbad triaged this task as High priority.

April 13, 2022 Update:

  • The API Gateway team met to discuss the different types of APIs we need to support to ensure we have a shared understanding
  • outlined the current state of certain Gateway features
  • discussed blockers for other teams from leveraging the API Gateway

Action/Next Steps:

  • we will prioritize supporting "partner" API types with the following:
    • API key level rate limits
    • API global rate limits
    • API global + key level rate limiting
  • Ensure that we balance Gateway config parameters with API design
    • for example: -we won't add custom parameters by API type, we will need to account for this in API design guidelines
      • we will enhance Gateway config with new parameters only when that will be widely used across APIs
• DAbad added a project: Foundational Technology Requests.Apr 13 2022, 3:44 PM

Adding to Foundational Tech Board for tracking due to dependencies

• DAbad moved this task from Backlog to Work In Progress on the Foundational Technology Requests board.Apr 13 2022, 3:45 PM
akosiaris subscribed.Apr 14 2022, 10:50 AM
• DAbad updated the task description. (Show Details)Apr 21 2022, 1:03 PM
• DAbad added a subtask: T295956: Proposal: add a per-service rate limit setting to API Gateway.Apr 26 2022, 1:57 PM
• DAbad updated the task description. (Show Details)Apr 26 2022, 2:09 PM
• DAbad added a subtask: T299649: Limit problematic queries for WCQS.Apr 27 2022, 3:58 PM
VirginiaPoundstone added a project: Epic.Sep 15 2022, 5:10 PM
hnowlan closed subtask T295956: Proposal: add a per-service rate limit setting to API Gateway as Resolved.Oct 4 2022, 4:28 PM
VirginiaPoundstone moved this task from Develop to Own on the API Platform (API Platform Roadmap) board.Oct 7 2022, 7:03 PM
VirginiaPoundstone added a subtask: T318096: <spike> Test Plan for API Gateway feature testing.Oct 7 2022, 7:24 PM
VirginiaPoundstone added a subtask: T326697: Harden API Gateway in preparation for RESTbase deprecation service migration.Jan 11 2023, 2:31 AM
VirginiaPoundstone added a subtask: T324130: Update API gateway to newer version of Envoy.
Aklapper changed the status of subtask T299649: Limit problematic queries for WCQS from Stalled to Open.Feb 9 2023, 12:13 PM
VirginiaPoundstone moved this task from API Platform Roadmap to API Gateway Roadmap on the API Platform board.Apr 26 2023, 12:25 PM
VirginiaPoundstone edited projects, added API Platform (API Gateway Roadmap); removed API Platform (API Platform Roadmap).
hnowlan closed subtask T324130: Update API gateway to newer version of Envoy as Resolved.Nov 14 2023, 5:43 PM
hnowlan reopened subtask T324130: Update API gateway to newer version of Envoy as Open.Nov 14 2023, 5:48 PM
JMeybohm closed subtask T324130: Update API gateway to newer version of Envoy as Resolved.Nov 23 2023, 10:12 AM
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