FLOIP / flow-spec

7 stars 6 forks source link

Determine format for Resources #29

Open markboots opened 6 years ago

markboots commented 6 years ago

We need to decide on the format used for Resources, which are set of localized strings or audio(media) resources.

An example draft to start:

A Resource describes a collection of localized strings or media resources, used when content needs to be presented to Contacts in multiple languages. Resources have the following following structure:

[resource-uuid]:{
  "id":[resource-uuid],
  "text":{
    [iso-639-3 language code]:[localized text],
    [iso-639-3 language code]:[localized text],
    ...
    [iso-639-3 language code]:[localized text],
  },
  "audio":{
    [iso-639-3 language code]:[media ID],
    [iso-639-3 language code]:[media ID],
    ...
    [iso-639-3 language code]:[media ID],
  }
}

for instance,

"6681c54c-9fcd-11e7-abc4-cec278b6b50a":{
  "id":"6681c54c-9fcd-11e7-abc4-cec278b6b50a"
  "text":{
    "eng":"How are you?",
    "aka":"Wo ho te sɛn?",
    "dag":"A mal’ alaafee?"
  },
  "audio":{
    "eng":"5718eb16.wav",
    "aka":"5f6e4694.wav",
    "dag":"68bd67f2.wav"
  }
}

Questions: