[OASIS Issue Tracker] (COEL-158) Consistency of JSON object specifications

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

    [ https://issues.oasis-open.org/browse/COEL-158?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=66823#comment-66823 ] 

Paul Bruton commented on COEL-158:
----------------------------------

Agreed to have five columns:

KEY (currently called Name)
VALUE (Meaning: e.g. "array of pseudonymous keys". "Array of device, see below", "DateTimeString")
TYPE (JSON TYPE)
DESCRIPTION Free Text
REQUIRED: Yes, No or See x.y.z THis refers to whether the key is required.

The glossary can have some definitions. E.g. PseudonymousKey [without spaces] as an additional entry to "Pseudonymous Key"

> Consistency of JSON object specifications
> -----------------------------------------
>
>                 Key: COEL-158
>                 URL: https://issues.oasis-open.org/browse/COEL-158
>             Project: OASIS Classification of Everyday Living (COEL) TC
>          Issue Type: Improvement
>         Environment: Whole document
>            Reporter: Joss Langford
>
> We have 3 standard table headings for JSON objects: Name, Value & Description. The way that 'Value' is populated varies through the document:
> - sometimes just the JSON type e.g. "Integer"
> - sometimes the JSON type with qualifier e.g. "String, HTTP URL"
> - sometimes our own definition e.g. "Two letter country code"



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)