Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-864

Translate @Core.Description annotations into JSON Schema description keywords

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: CSDL JSON
    • Labels:
      None
    • Environment:

      Applied

      Description

      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

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              handl Ralf Handl
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: