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

3.8 Representing Annotations: avoid the undefined terms "internally" and "externally"

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: JSON Format
    • Labels:
      None
    • Proposal:
      Hide

      Section 3.8, paragraph after example

      OLD: In general, it is possible to express an annotation internally or externally to a value. However, an annotation is always a name/value pair. Therefore, it can only be expressed within a JSON object. Some EDM constructs are not represented with JSON objects. Therefore some types may only be annotated externally.

      NEW: Annotations are always expressed as name/value pairs. For entity data model constructs represented as JSON objects the annotation name/value pairs are placed within the object; for constructs represented as JSON arrays or primitives they are placed next to the annotated model construct.

      Section 3.8.1, beginning of the section

      OLD: This section applies when annotating a name/value pair for which the value is represented as a JSON object. Each annotation MUST be applied internally. Each annotation MUST be represented as a single name/value pair.

      NEW: This section applies when annotating a name/value pair for which the value is represented as a JSON object. Each annotation MUST be applied within the object. Each annotation MUST be represented as a single name/value pair.

      3.8.2, beginning of the section

      OLD: This section applies when annotating a name/value pair for which the value is not represented as a JSON object. The set of all annotations that apply to this name/value pair MUST be applied externally. This set of annotations is represented as a single name/value pair.

      NEW: This section applies when annotating a name/value pair for which the value is not represented as a JSON object. The set of all annotations that apply to this name/value pair MUST be be placed next to the annotated model construct. This set of annotations is represented as a single name/value pair.

      Accepted: https://www.oasis-open.org/apps/org/workgroup/odata/download.php/47020/latest/odata_meeting-9_on-20120927_minutes.html

      Show
      Section 3.8, paragraph after example OLD: In general, it is possible to express an annotation internally or externally to a value. However, an annotation is always a name/value pair. Therefore, it can only be expressed within a JSON object. Some EDM constructs are not represented with JSON objects. Therefore some types may only be annotated externally. NEW: Annotations are always expressed as name/value pairs. For entity data model constructs represented as JSON objects the annotation name/value pairs are placed within the object; for constructs represented as JSON arrays or primitives they are placed next to the annotated model construct. Section 3.8.1, beginning of the section OLD: This section applies when annotating a name/value pair for which the value is represented as a JSON object. Each annotation MUST be applied internally. Each annotation MUST be represented as a single name/value pair. NEW: This section applies when annotating a name/value pair for which the value is represented as a JSON object. Each annotation MUST be applied within the object. Each annotation MUST be represented as a single name/value pair. 3.8.2, beginning of the section OLD: This section applies when annotating a name/value pair for which the value is not represented as a JSON object. The set of all annotations that apply to this name/value pair MUST be applied externally. This set of annotations is represented as a single name/value pair. NEW: This section applies when annotating a name/value pair for which the value is not represented as a JSON object. The set of all annotations that apply to this name/value pair MUST be be placed next to the annotated model construct. This set of annotations is represented as a single name/value pair. Accepted: https://www.oasis-open.org/apps/org/workgroup/odata/download.php/47020/latest/odata_meeting-9_on-20120927_minutes.html
    • Resolution:
      Show
      Proposed changes applied in revision 6 ( https://www.oasis-open.org/apps/org/workgroup/odata/download.php/47051/odata-json-format-v1.0-wd01-2012-09-30-MB.doc ) Accepted: https://www.oasis-open.org/apps/org/workgroup/odata/download.php/47096/latest/odata_meeting-10_on-20121004-minutes.html

      Description

      Section 3.8 uses the phrase "express an annotation internally or externally" without defining the terms.

      Instead just point out that the representation of annotation depends on the representation of the annotated model construct.

        Attachments

          Activity

            People

            • Assignee:
              mark.biamonte Mark Biamonte (Inactive)
              Reporter:
              mark.biamonte Mark Biamonte (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: