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

Correct the sample inside section "JSON DeltaQuery Result Example" inside ODQP proposal pages 9/10

    Details

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

      [Closed]

      Description

      Inside the current revision of the proposal for an OData Delta Query Protocol i.e. [OData Delta Query Protocol Design 2012-12-19.docx](https://www.oasis-open.org/committees/download.php/47755/OData%20Delta%20Query%20Protocol%20Design%202012-12-19.docx) the sample inside section "JSON DeltaQuery Result Example" is syntactically invalid. A diff to a validating version yields:

      """
      $> diff -u original_odqp_json-sample.json valid_odqp_json-sample.json
      — original_odqp_json-sample.json 2013-01-05 14:33:29.000000000 +0100
      +++ valid_odqp_json-sample.json 2013-01-05 14:34:22.000000000 +0100
      @@ -11,7 +11,7 @@
      "odata.type" : "odata.deletedLinkEntry",
      "ref":"http://DeltaService.svc/Customers(ALFKI)'",
      "relationship":"Orders",

      • "related":http://DeltaService.svc/Orders(10643),
        + "related":"http://DeltaService.svc/Orders(10643)",
        "when":"2012-11-07T15:38",
        },
        { @@ -36,7 +36,7 @@ "ShipCountry":"Canada" }

        ,
        {

      • "odata.type":"odata.deletedEntry":
        + "odata.type":"odata.deletedEntry",

      "odata.id":"http://DeltaService.svc/Customers('ALFKI')",
      "when":"2012-11-07T15:38",
      "reason": "deleted",

      """

      I suggest replacing the sample by:
      """
      {
      "odata.metadata": "http://DeltaService.svc/$metadata ",
      "odata.deltaLink": "http://DeltaService.svc/Customers?$expand=orders&$deltatoken=8015",
      "value": [

      { "odata.type": "Northwind.Customer", "odata.id": "http://DeltaService.svc/Customers('BOTTM')'", "ContactName": "Susan Halvenstern" }

      ,

      { "odata.type": "odata.deletedLinkEntry", "ref": "http://DeltaService.svc/Customers(ALFKI)'", "when": "2012-11-07T15:38", "relationship": "Orders", "related": "http://DeltaService.svc/Orders(10643)" }

      ,

      { "odata.type": "odata.linkEntry", "ref": "http://DeltaService.svc/Customers('BOTTM')", "relationship": "Orders", "related": "http://DeltaService.svc/Orders(10643)" }

      ,

      { "odata.type": "odata.linkEntry", "ref": "http://DeltaService.svc/Orders(10643)", "relationship": "Customer", "related": "http://DeltaService.svc/Customers('BOTTM')" }

      ,

      { "odata.type": "Northwind.Order", "ShipName": "Bottom-Dollar Markets", "ShipPostalCode": "T2F 8M4", "ShipRegion": "BC", "ShipCountry": "Canada", "odata.id": "http://DeltaService.svc/Orders(10643)", "ShipAddress": "23 Tsawassen Blvd." }

      ,

      { "odata.type": "odata.deletedEntry", "reason": "deleted", "when": "2012-11-07T15:38", "odata.id": "http://DeltaService.svc/Customers('ALFKI')" }

      ]
      }
      """

        Attachments

          Activity

          Hide
          mikep Michael Pizzo (Inactive) added a comment -

          I have addressed these as editorial fixes in version 1.2.

          Show
          mikep Michael Pizzo (Inactive) added a comment - I have addressed these as editorial fixes in version 1.2.
          Hide
          sdrees Stefan Drees (Inactive) added a comment - - edited

          Thanks a lot for the notification.
          I for one will regard every valid JSON (matching the "ingredient list" in the text above the format sample) as successfull application of the issue (i.e. hopefully not needed to be discussed as gang-of-twenty

          Update: The JSON sample in [OData Delta Query Protocol Design 2013-1-23.docx](https://www.oasis-open.org/committees/download.php/47996/OData%20Delta%20Query%20Protocol%20Design%202013-1-23.docx) is valid (though I would not want to consume it on the client side in that form .

          I acknowledge the issue as applied in the current revision (cf. above).

          PS: Inserting/formatting/highlighting code in office tools like Word should be fine controlled IMO only in later stages to save resources for the *real* work.
          The current sample offers values like ...Customers('BOTTM')' or Customers(ALFKI)' or URLs appended with a space, (which typically stems from the word intelligent insertion support or visibility problems due to proportional and/or sans-serif fonts. That was meant with the above "consumer" remark.

          Show
          sdrees Stefan Drees (Inactive) added a comment - - edited Thanks a lot for the notification. I for one will regard every valid JSON (matching the "ingredient list" in the text above the format sample) as successfull application of the issue (i.e. hopefully not needed to be discussed as gang-of-twenty Update: The JSON sample in [OData Delta Query Protocol Design 2013-1-23.docx] ( https://www.oasis-open.org/committees/download.php/47996/OData%20Delta%20Query%20Protocol%20Design%202013-1-23.docx ) is valid (though I would not want to consume it on the client side in that form . I acknowledge the issue as applied in the current revision (cf. above). PS: Inserting/formatting/highlighting code in office tools like Word should be fine controlled IMO only in later stages to save resources for the * real * work. The current sample offers values like ...Customers('BOTTM')' or Customers(ALFKI)' or URLs appended with a space, (which typically stems from the word intelligent insertion support or visibility problems due to proportional and/or sans-serif fonts. That was meant with the above "consumer" remark.

            People

            • Assignee:
              mikep Michael Pizzo (Inactive)
              Reporter:
              sdrees Stefan Drees (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: