L10n:Pontoon/API: Difference between revisions

Add Contact
(Add Overview)
(Add Contact)
Line 1: Line 1:
==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 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 [http://graphql.org/ GraphQL] (see [https://wiki.mozilla.org/index.php?title=L10n:Pontoon/API&oldid=1181890#Technology discussion]).
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 [http://graphql.org/ GraphQL] (see [https://wiki.mozilla.org/index.php?title=L10n:Pontoon/API&oldid=1181890#Technology discussion]).


The tracking bug for all work related to the API for Pontoon is {{bug|pontoon-api}}.
The tracking bug for all work related to the API for Pontoon is {{bug|pontoon-api}}.


==Overview==
==Overview==
Line 38: Line 39:
|}
|}


==Roadmap==


==Milestone 1==
===Milestone 1===


''Complete, deployed on October 2, 2017.''  
''Complete, deployed on October 2, 2017.''  
Line 55: Line 57:
}</bugzilla>
}</bugzilla>


==Milestone 2==
===Milestone 2===


Main theme: translations and pagination.
Main theme: translations and pagination.
Line 69: Line 71:
** List all TranslatedResources for a ProjectLocale?
** List all TranslatedResources for a ProjectLocale?


==Milestone 3==
===Milestone 3===


Main theme: contributors.
Main theme: contributors.
Line 82: Line 84:
* List all contributors for a project
* List all contributors for a project


==Milestone 4==
===Milestone 4===


Main theme: authentication.
Main theme: authentication.
Line 88: Line 90:
* List unread notifications for a logged-in user.
* List unread notifications for a logged-in user.


==Milestone 5==
===Milestone 5===


Main theme: mutations.
Main theme: mutations.


* Add a suggested translation for an Entity.
* Add a suggested translation for an Entity.
==Contact==
{| class="wikitable"
! style="text-align: center;" | Role
! style="text-align: center;" | Name
! style="text-align: center;" | IRC
|-
| Feature Owner
| Staś Małolepszy
| stas
|-
| Product Owner
| Matjaž Horvat
| mathjazz
|-
| Reviewer
| Adrian Gaudebert
| adrian
|}
;Mailing list
:[https://groups.google.com/forum/#!forum/mozilla.tools.l10n tools-l10n]
;IRC
:[irc://irc.mozilla.org/pontoon #pontoon]
canmove, Confirmed users
1,448

edits