Translate @Core.Description annotations into JSON Schema description keywords

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

      Applied

      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

            Assignee:
            Unassigned
            Reporter:
            handl
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: