Skip to content

Determine format for Resources #29

@markboots

Description

@markboots

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:

  • Do we need to support media resources other than audio? e.g. localized video, for smartphone channels?
  • Is it valuable to have the key also inside the resource body, not just in the external key?
  • Should we list the languages separately at the top level?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions