Search for keys (API)
Open, MediumPublic
Actions

Assigned To

None

Authored By

	Amire80
	Feb 20 2015, 2:31 PM

Description

Migrated from: https://wikimedia.mingle.thoughtworks.com/projects/language_engineering/cards/1168

Context

This story is part of the below context, and describes requirements that will make the APIs of the Translation extension more complete, which will allow for easier integration with and developing against the Translate extension. https://docs.google.com/a/wikimedia.org/spreadsheet/ccc?key=0AkIZioxVCgqedEV0WXA3R25NYU9KUmdjWnM2UnJtRUE#gid=0 details all possible aspects of the Translate extension API (52 features in 4 API dimensions – commandline, special page, interal, web API).

The following assessments have been made for each of the 208 cells:

Is this functionality currently supported? Green: Good interface and documentation exist, Orange: Interface exists, but there is a problem with the implementation or documentation, Yellow: Work in progress, Red: No interface or hard to use.
Is this functionality of any importance? Empty for not important, filled cells with priority from highest (1) to lowest (*). D means documentation should be added or updated. Of the 208 cells, 26 cells have a priority of 1 and 10 cells have an indication that documentation should be added or updated.

Use cases

I want to find all messages from message group X, that contain string Y (excluding stuff like _ and &) and see how they are translated into language Z to easily fix all translations to be consistent.
I want to find all messages that contain term Y and see how they are translated into language Z.
I want to find all translations that use deprecated term Y so that I can easily fix them.
I saw an incorrect translation and I want to find the message so that I can correct it. I may only remember the translation partially.
I saw a untranslated message in the interface, and I want to find it to translate it.
I am translating a new message and I want to see how similar messages have been translated before to maintain consistency (~ translation memory feature)

Some common things:

Search results should display the source text and the translation into (one) language
Easy access to change the translation needed (UI stuff, not really API)
Need to be able to limit to message groups

Narrative

As a Translate extension API user I can query for message keys (optionally per message group) containing a search string in a language so that I can present these in a UI.