Draft specification based on #1

FLOIP / flow-results

Open specification for the exchange of "Results" data generated by mobile platforms using the "Flow" paradigm

6 stars 2 forks source link

Draft specification based on #1 #2

Closed markboots closed 6 years ago

markboots commented 6 years ago

Agreed on call today:

Make title recommended in descriptor, because name has constraints. Purpose of title is for display.
Make id is optional for initial Data Collectors (the first system to publish the data), required after that. Specify the format (e.g. uuid v4).

markboots commented 6 years ago

Within schema: recommended property of language , default language for the questions. In ISO 639-3. (e.g. eng)

markboots commented 6 years ago

Holding session_id optional:
- Option 1: new optional column for session_id. Avoids lots of repeated session_id text.
- Option 2: allow putting in response_metadata. Most minor change.
- Option 3: extension column with an extra JSON blob (required, can be null or empty object). Includes whatever extensions systems want to include. Suggestion that one of these session_id. Most extensible. Question: do we have a standard list of optional things, and include X-prefix for things outside the standard list?

Leaning toward Option 3 right now, but will make an issue to confirm and get input from Dickson and Nic.

markboots commented 6 years ago

Can we push this PR toward approval? Would love to get it merged in. We have outstanding issues open on API support and where to put Session IDs, that can be addressed as individual things after merging this main foundation. The rest of the comments have been incorporated.

@pld @ukanga @ggiraldez @edjez @ewheeler can we get your formal vote for approval, disapprove, abstain, block? Thanks!

markboots commented 6 years ago

Thanks guys! Merged! We have a foundation.