L10n:Pontoon/API: Difference between revisions

m
mNo edit summary
 
(4 intermediate revisions by the same user not shown)
Line 18: Line 18:
|-
|-
| M3
| M3
| Statistics over time
|
|-
| M4
| Contributors
| Contributors
|
|
|-
|-
| M4
| M5
| Translation Memory
| Translation Memory
|
|
|-
|-
| M5
| M6
| Translations
| Translations
|
|
Line 57: Line 61:
Queries:
Queries:


* List unread notifications for a logged-in user.
* [[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: Contributors===
===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?)
* Query a single contributor (by email? unique key?)
** List recent activity: date, project, action, number of affected strings
** List contributor data: email, display name, permissions, settings
** List recent activity: date, string, action
** Aggregate counts of: translated, unreviewed, fuzzy strings across all projects
** Aggregate counts of: translated, unreviewed, fuzzy strings across all projects
** List of projects they contribute to
** List of projects they contribute to
Line 70: Line 95:
* List all contributors for a project
* List all contributors for a project
* List all contributors for a localization (ProjectLocale)
* List all contributors for a localization (ProjectLocale)
* One common use case from the past: [https://docs.google.com/spreadsheets/d/1-QWPJovsag4eYghkK2MMo30wa7QzOOMQkZdIjXnfZGQ/edit#gid=532595279 Number of user groups per locale].
* Statistics over time. [https://public.etherpad-mozilla.org/p/pontoon.api.historic.source.string.data Early rumblings and a use case].


===Milestone 4: Translation memory===
===Milestone 5: Translation memory===


Use-cases:
Use-cases:
Line 85: Line 107:
* For a given source string, locale and minimum Levenshtein ratio, return a maximum number of results.
* For a given source string, locale and minimum Levenshtein ratio, return a maximum number of results.


===Milestone 5: Translations===
===Milestone 6: Translations===


Use-cases:
Use-cases:
Confirmed users
1,276

edits