903194 - Allow collection API endpoints to accept localised `name` and `description`

Status: RESOLVED FIXED

(Marketplace Graveyard :: API, defect, P2)

Description

[Christopher Van Wiemeersch [:cvan]]

http://firefox-marketplace-api.readthedocs.org/en/latest/topics/rocketfuel.html#post--api-v1-rocketfuel-collections-
http://firefox-marketplace-api.readthedocs.org/en/latest/topics/rocketfuel.html#patch--api-v1-rocketfuel-collections-(int-id)-

Because we need to localise the `name` and `description` for collections we should be able to POST an object that contains the mapping for each locale, like so:

    {
        "name": {
            "en-US": "Basta the potato",
            "fr": "Basta la pomme de terre",
            "es": "Basta la patata",
            "it": "Basta la patata"
        },
        "description: {
            "en-US": "Basta likes potatoes",
            "fr": "Basta ama patate e Le Boulanger",
            "es": "Basta gusta las patatas y Le Boulanger",
            "it": "Basta ama patate e Le Boulanger"
        }
    }

Comment 1

[Davor Spasovski [:spasovski]]

Everything about this bug is awesome!

Comment 2

[Christopher Van Wiemeersch [:cvan]]

(In reply to Christopher Van Wiemeersch [:cvan] from comment #0)
>             "en-US": "Basta likes potatoes",

Correction:

             "en-US": "Basta likes potatoes and Le Boulanger",

Comment 3

[Mathieu Pillard [:mat]]

Fixed in https://github.com/mozilla/zamboni/commit/3d7fcf87dab4e5f1857eb6dd5d54e88efe88fa17

Comment 4

[Matt Basta [:basta]]

A few followup questions:

- Will the API always return the object or will it sometimes return the string version of those fields?
- What does the API use to determine the default locale for a field?

Comment 5

[Mathieu Pillard [:mat]]

Currently:
1. The API return the string version, always, even in the response following an edit/create action. (Yes, this is confusing).
2. The default_locale used is en-US (actually settings.LANGUAGE_CODE). Behaviour when no en-US translation is provided is undefined.

Let me know if we need to tweak those points.

Comment 6

[Matt Basta [:basta]]

I think we'll need to be able to get the object back from the API. Do you want me to file a followup bug for tweaks?

Comment 7

[Mathieu Pillard [:mat]]

Yep please, that'd be great. Assign it directly to me, thanks.