[OASIS Issue Tracker] (ODATA-864) Translate @Core.Description annotations into JSON Schema description keywords

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

     [ https://issues.oasis-open.org/browse/ODATA-864?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ralf Handl updated ODATA-864:
-----------------------------

    Environment: Applied

> Translate @Core.Description annotations into JSON Schema description keywords
> -----------------------------------------------------------------------------
>
>                 Key: ODATA-864
>                 URL: https://issues.oasis-open.org/browse/ODATA-864
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData JSON CSDL
>    Affects Versions: V4.0_WD01
>         Environment: Applied
>            Reporter: Ralf Handl
>             Fix For: V4.0_WD01
>
>
> JSON Schema defines keywords title and description, see
> http://json-schema.org/latest/json-schema-validation.html#anchor98. 
> A "title" is short and seems to correspond to field labels or column headers, whereas "description" seems to correspond to an explanation shown as a tooltip. The latter seems in sync with use for Core.Description.
> Currently the Core annotation Description is represented as an instance annotation:
> "@Core.Description": "Some explanatory text explaining this model element and its use and/or restrictions"
> Instead it could become a JSON Schema description:
> "description": "Some explanatory text explaining this model element and its use and/or restrictions"
> Pro:
> - Recognizable by JSON Schema consumers
> Con:
> - Different representation as @Core.LongDescription which doesn't have a counterpart in JSON Schema



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