Overview
In order to determine how the API Platform can provide value for the Movement, we need to understand how all WMF maintained APIs are currently being used.
Our goal is to provide transparent, equitable access to our data and knowledge as part of the 2030 WMF strategic direction.
User Story
As the API Value stream team,
I need to know what data, how much traffic, and by whom calls are made for all WMF services
so I can develop an understanding of our current API and service ecosystem, what our team's scope is within the ecosystem, and look for areas where value can be added by our team.
List of known APIs to gather observable data from (in order of priority)
- Action API
- RESTbase
- MediaWiki REST API
- Wikidata Query Service (WDQS)
- Wikidata API
- EventGate
- EventStreams
- Maps Service
- Push Notifications Service
- Mobile View API
- Recommendation Service
- Kask Service
- ORES Service
- Proton Service
- Trending Edits
- Thumbor
- Image suggestion API
- Public Image suggestion API
Acceptance criteria
- Catalog of all know API services supported by technology department
- Current routing and directional (NSEW) information for each independently deployed API service and/or endpoint
- Type of protocol (REST, SOAP, RPC, SparQL, etc) for each
- Usage and traffic data (visualized if possible)
- Known application dependencies
- Technical and product ownership, if known
- Repository for each service
Research Doc
API Platform Knowldge Hub, API Catalog
https://backstage-api-catalog.toolforge.org/api-docs?filters%5Bkind%5D=api&filters%5Buser%5D=all
https://www.mediawiki.org/wiki/Core_Platform_Team/Initiatives/API_Platform/API_list
https://meta.wikimedia.org/wiki/Toolhub
https://gerrit.wikimedia.org/r/plugins/gitiles/operations/puppet/+/refs/heads/production/hieradata/common/profile/services_proxy/envoy.yaml