|Deletions are marked like this.||Additions are marked like this.|
|Line 104:||Line 104:|
|[[../ApiDevelopment|Previous discussion on the API development]]
[[/ProposedCalls|Proposed API calls]]
| * [[../ApiDevelopment|Previous discussion on the API development]]
* [[/ProposedCalls|Proposed API calls]]
Launchpad Translations API
Development of a Launchpad Translations API.
This Launchpad enhancement proposal discusses extending the functionality of Launchpad Translations by allowing read and write access to translations-related data from Launchpad through launchpadlib.
On Launchpad: https://blueprints.launchpad.net/rosetta/+spec/api
As the $PERSON
I want $FEATURE
so that $BENEFIT
Consider clarifying the feature by describing what it is not?
Why are we doing this now?
What value does this give our users? Which users?
Ubuntu Desktop Team: Arne Goetje
Canonical OEM team: Kyle Nitzsche
The new behaviour must provide a way to access translations data from Launchpad, either in read (or depending on the value) or write mode through launchpadlib, without the need for an admin to query the database.
It must not provide a way to circumvent any security privileges built in the layers above (e.g. Launchpad UI)
The API can be initially subdivided in several areas, which will be exposed separately below.
Retrieve the list of all languages available in Launchpad.
- Language code
- Language name in English
- Language state (visible or not)
- Plural forms (optional, for checking language support)
- Text direction (optional)
It would be nice to some other data presented on language page https://translations.launchpad.net/+languages/ro , but this is a good start
It would be nice to be able to query just a specific language.
Retrieve the list of all templates available for a series in Launchpad.
- template name in Launchpad
- date last updated
- domain name
- iscurrent (active or not)
- source package
- is in lang pack
- the list of POFiles associated with this POTemplate
- in how many languages it is translates (nice to have)
It would be nice to be able to query a template from a series, based on the Launchpad template name.
Retrieve the list of all PO files for a template in a series.
The list should contain:
- language code
- when the translation was last updated
- number of translated messages
- number of unreviewed messages
- number of changed messages
- who was the last translator
What are the workflows for this feature? Provide mockups for each workflow.
You do not have to get the mockups and workflows right at this point. In fact, it is better to have several alternatives, delaying deciding on the final set of workflows until the last responsible moment.
How will we know when we are done?
How will we measure how well we have done?