Confirmed users
1,276
edits
L10n:Pontoon/API: Difference between revisions
m
→Milestone 3: Statistics over time
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
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 | 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 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 [http://graphql.org/ GraphQL] (see [https://wiki.mozilla.org/index.php?title=L10n:Pontoon/API&oldid=1181890#Technology discussion]). | ||
==Overview== | ==Overview== | ||
| Line 7: | Line 7: | ||
! style="text-align: center;" | Milestone | ! style="text-align: center;" | Milestone | ||
! style="text-align: center;" | Theme | ! style="text-align: center;" | Theme | ||
! style="text-align: center;" | Status | ! style="text-align: center;" | Status | ||
|- | |- | ||
| M1 | | M1 | ||
| Projects and Locales | | Projects and Locales | ||
| ✓ | | ✓ | ||
|- | |- | ||
| M2 | | M2 | ||
| | | User Notifications | ||
| | | | ||
|- | |- | ||
| M3 | | M3 | ||
| | | Statistics over time | ||
| | | | ||
|- | |- | ||
| M4 | | M4 | ||
| | | Contributors | ||
| | | | ||
|- | |- | ||
| M5 | | M5 | ||
| | | Translation Memory | ||
| | | | ||
|- | |||
| M6 | |||
| Translations | |||
| | | | ||
|- | |- | ||
|} | |} | ||
==Roadmap== | ==Roadmap== | ||
===Milestone 1=== | ===Milestone 1: Projects and Locales=== | ||
''Complete, deployed on October 2, 2017.'' | ''Complete, deployed on October 2, 2017.'' | ||
| Line 66: | Line 53: | ||
</bugzilla> | </bugzilla> | ||
===Milestone 2=== | ===Milestone 2: User notifications=== | ||
Use-cases: | |||
* [[L10n:Pontoon-Tools|Michal's Pontoon Tools extension]] | |||
Queries: | |||
* [[L10n:Pontoon-Tools#Data_sources|See Data sources section on the Pontoon Tools wiki]] | |||
* Authentication (only return non-public data like notifications if the API consumer is authenticated) | |||
===Milestone 3: Statistics over time=== | |||
Use-cases: | |||
* Community Health, e.g.: | |||
** Translation progress over time. | |||
** Unreviewed suggestions progress over time. | |||
Queries: | |||
* [https://docs.google.com/document/d/1FlZLe8m2sFX6-AT9u_R8D4IODzcTNfx3d1QNaFzT1MQ/edit Get a number of strings per project within a period of time]. | |||
** Or a number of words. | |||
===Milestone 4: Contributors=== | |||
Use-cases: | |||
* [https://docs.google.com/spreadsheets/d/1-QWPJovsag4eYghkK2MMo30wa7QzOOMQkZdIjXnfZGQ/edit#gid=532595279 Number of user groups per locale]. | |||
Queries: | |||
* Query a single contributor (by email? unique key?) | |||
** List contributor data: email, display name, permissions, settings | |||
** List recent activity: date, string, action | |||
** Aggregate counts of: translated, unreviewed, fuzzy strings across all projects | |||
** List of projects they contribute to | |||
*** Aggregate counts of: translated, unreviewed, fuzzy strings for each project | |||
* List all contributors on Pontoon | |||
* List all contributors for a locale | |||
* List all contributors for a project | |||
* List all contributors for a localization (ProjectLocale) | |||
===Milestone 5: Translation memory=== | |||
Use-cases: | |||
* External services. | |||
* Mozilla translators in non-Mozilla projects. | |||
Queries: | |||
* For a given source string, locale and minimum Levenshtein ratio, return a maximum number of results. | |||
===Milestone 6: Translations=== | |||
Use-cases: | Use-cases: | ||
| Line 74: | Line 113: | ||
* Report translation status of a single page on mozilla.org | * Report translation status of a single page on mozilla.org | ||
* Read-only data required by Pontoon.Next's Translate app | * Read-only data required by Pontoon.Next's Translate app | ||
* Editing translations via Pontoon.Next's Translate app | |||
Queries: | Queries: | ||
| Line 81: | Line 121: | ||
* List all Entities for a Resource. | * List all Entities for a Resource. | ||
* List all Translations into a given Locale for an Entity. | * List all Translations into a given Locale for an Entity. | ||
** Include status: approved, | ** Include status: approved, unreviewed, fuzzy. | ||
** Allow filtering on status via params? | ** Allow filtering on status via params? | ||
** List all Translations for an Entity | ** List all Translations for an Entity | ||
| Line 88: | Line 128: | ||
** List all TranslatedResources for a Resource. | ** List all TranslatedResources for a Resource. | ||
** List all TranslatedResources for a Locale. | ** List all TranslatedResources for a Locale. | ||
* Add a translation for an Entity | |||
** "approved" if the permissions are high enough | |||
** "unreviewed" otherwise | |||
* Approve/reject a suggestion. | |||
<bugzilla>{ | <bugzilla>{ | ||
| Line 95: | Line 139: | ||
"include_fields": "id, summary, status, resolution, priority, assigned_to" | "include_fields": "id, summary, status, resolution, priority, assigned_to" | ||
}</bugzilla> | }</bugzilla> | ||
==Ideas== | ==Ideas== | ||
A list of ideas to consider for future milestones. | A list of ideas to consider for future milestones. | ||
==Contact== | ==Contact== | ||