L10n:Pontoon/API
Exposing Pontoon's data through an API will enable external consumers to build tools, extensions and reports about translations. In the future, the API will serve as the backend for Pontoon.NEXT's SPA front-end. We chose an iterative approach to exposing the data. We start small with a small number of clear-focused use-cases in mind and expand the scope in subsequent iterations. The API is based on GraphQL (see discussion).
The tracking bug for all work related to the API for Pontoon is bug pontoon-api.
Overview
| Milestone | Theme | Date | Status |
|---|---|---|---|
| M1 | Projects and Locales | September 2017 | ✓ |
| M2 | Translations | November 2017 | |
| M3 | Contributors | January 2018 | |
| M4 | Authentication | March 2018 | |
| M5 | Mutations | May 2018 |
Milestone 1
Complete, deployed on October 2, 2017.
In the first iteration we'd like to make some data stored in Pontoon openly available for third-parties. The goals is to create an API endpoint supporting queries related to aggregate statistics per locale and per project. The main driver is the use case from bug 1302053:
- Stats for a locale: supported projects, status of each project.
- Stats for a project: supported locales, incomplete locales, complete locales.
Bugzilla query error
Array ( [type] => error [message] => http-bad-status [params] => Array ( [0] => 406 [1] => Not Acceptable ) ) 1
Milestone 2
Main theme: translations and pagination.
- Establish a good practice for paginating results.
- List all Resources for a Project.
- List all Entities for a Resource.
- List all Translations for an Entity.
- Include status: approved, suggested, fuzzy.
- List all TranslatedResources for a Resource.
- Include aggregate statistics.
- List all TranslatedResources for a Locale.
- List all TranslatedResources for a ProjectLocale?
Milestone 3
Main theme: contributors.
- Query a single contributor (by email? unique key?)
- List recent activity: date, project, action, number of affected strings
- Aggregate counts of: translated, suggested, fuzzy strings across all projects
- List of projects they contribute to
- Aggregate counts of: translated, suggested, fuzzy strings for each project
- List all contributors on Pontoon
- List all contributors for a locale
- List all contributors for a project
Milestone 4
Main theme: authentication.
- List unread notifications for a logged-in user.
Milestone 5
Main theme: mutations.
- Add a suggested translation for an Entity.