Page MenuHomePhabricator

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

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

Event Timeline

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

Adding to Foundational Tech Board for tracking due to dependencies

Removing inactive task assignee. (Please do so as part of offboarding - thanks.)