L10n:Pontoon/API

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 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).

Overview

Roadmap

Milestone 1: Projects and Locales

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.

1 Total; 0 Open (0%); 1 Resolved (100%); 0 Verified (0%);

Milestone 2: User notifications

Use-cases:

• Michal's Pontoon Tools extension

Queries:

• 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:

• Get a number of strings per project within a period of time.
  • Or a number of words.

Milestone 4: Contributors

Use-cases:

• 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:

• Report translation status of a single page on mozilla.org
• Read-only data required by Pontoon.Next's Translate app
• Editing translations via Pontoon.Next's Translate app

Queries:

• Establish a good practice for paginating results.
• List all Resources for a Project.
• List all Entities for a Resource.
• List all Translations into a given Locale for an Entity.
  • Include status: approved, unreviewed, fuzzy.
  • Allow filtering on status via params?
  • List all Translations for an Entity
• List all TranslatedResources for a ProjectLocale
  • Include aggregate statistics.
  • List all TranslatedResources for a Resource.
  • 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.

4 Total; 0 Open (0%); 4 Resolved (100%); 0 Verified (0%);

Ideas

A list of ideas to consider for future milestones.

Contact

Mailing list

tools-l10n

IRC

#pontoon