Page MenuHomePhabricator

View API Inventory
Open, Needs TriagePublic

Description

Context

Currently, we have many different places where lists of our API services and respective information on each of them exists. They are maintained manually and get out of sync very quickly.

User Stories & Acceptance Criteria
1. View list of APIs

As an API consumer (External Partner, Internal WMF Engineer),
I want to be able to see all API services & documentation in one place,
So that I can discover the API I need

  • I want to see a list of APIs in a single view with the following attributes
    • API Web Service Name
    • Owner
    • Link to reference documentation
2. Update API Catalog

As an API producer
I want a way to ensure information about my service stays up to date
so that API consumers can easily discover my API

  • Information about my service is version controlled
  • When I make changes to my service information, I expect that the catalog updates my information respectively
Open Questions
References

Event Timeline

sdkim renamed this task from Inventory API Services & Documentation to View API Inventory.Aug 25 2021, 5:16 PM
sdkim updated the task description. (Show Details)

Removing inactive task assignee.

Cross check other organizational efforts to gather API info:
Technical Engagement, Team APIs.