canmove, Confirmed users
1,448
edits
L10n:Pontoon/API: Difference between revisions
Jump to navigation
Jump to search
no edit summary
(→Cons) |
No edit summary |
||
| Line 1: | Line 1: | ||
''For now, this page serves as a scratchpad for documenting the research into different API solutions for Pontoon. Once one solution is chosen and implemented, this page will feature the documentation about this solution.'' | ''For now, this page serves as a scratchpad for documenting the research into different API solutions for Pontoon. Once one solution is chosen and implemented, this page will feature the documentation about this solution.'' | ||
High-level Q3 2017 goal: Create an API endpoint supporting queries related to aggregate statistics per locale and per project | |||
=Roadmap= | |||
In Q3 2017, we'd like to make some data stored in Pontoon openly available for third-parties. The main driver is the use case from {{bug|1302053}}: | In Q3 2017, we'd like to make some data stored in Pontoon openly available for third-parties. 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. | |||
In future iterations, more use-case can be supported: | |||
* Exposing data which can be fetched by a SPA front-end | |||
** This will likely require pagination | |||
* Getting the stream of notifications per authorized user | |||
=Technology= | |||
We'll be considering three solutions: REST, GraphQL and GraphQL with Relay. | We'll be considering three solutions: REST, GraphQL and GraphQL with Relay. | ||