907181 - Localizable field tweaks for Collections API

Status: VERIFIED FIXED

(Marketplace Graveyard :: API, defect, P2)

Description

[Matt Basta [:basta]]

1. Ability to get objects back for localizable fields
2. Default locale for localizable fields should be whatever's passed as "lang" parameter (if one is passed) on POST
3. Default locale should be somehow specified in localized objects when reading from the API. E.g.:

"name": {
 "en-US": "foo",
 "es": "bar",
 "__default": "en-US"
}

4. PATCHing a new value should overwrite the locale object entirely. If a locale is absent in the updated locale object, the locale should be removed from the field.

Comment 1

[Mathieu Pillard [:mat]]

1) Do you want the object back everytime ? i.e., never return simple strings anymore in the API for fields that can be translated?

2) and 3) Would it make sense to have default_locale instead of lang passed at creation/edit time, and then store and return it on the Collection instances themselves ? This would be the easiest to implement I think, this matches how Translation works internally.

4) Is impossible to implement right now :/ We currently can't delete Translation instances, bug 902435 has more info about this. We could have hacks to hide empty translations or something similar if needed.

Comment 2

[Matt Basta [:basta]]

1. On one hand, no, because it's a pain in the ass. But on the other more important hand, yes, because it's consistent and I'd rather do it right than hack it :)

2-3. I only suggested the lang parameter since it's what we'd specify anyway for the default locale. It might be nice to accept it in the object for other API consumers, but having the API fall back on the parameter might be a nice convenience.

4. Empty translations should definitely be hidden. The API should treat absent localizations as hidden.

Comment 3

[Mathieu Pillard [:mat]]

ok so I went with:

1. All translations should be returned everytime in the rocketfuel API. Reopen this bug if there are some places where it doesn't. We'll figure out what to do in the consumer API in bug  907820

2. and 3. `default_language` is now a parameter. It's stored on the Collection and returned in the response for every Collection object.

4. NULL translations are hidden. I'm not sure you can properly set them to NULL yet in the API though, I forgot to test that.

Comment 4

[Mathieu Pillard [:mat]]

Was fixed in https://github.com/mozilla/zamboni/commit/02232713bc9fe4e8b97f68f1732c565b8c970468

Comment 5

[Matt Basta [:basta]]

Verified