Alert clients that odata may be default namespace in future versions of the protocol

XMLWordPrintable

    • Type: Sub-task
    • Resolution: Duplicate
    • Priority: Major
    • V4.0_ERRATA01
    • Affects Version/s: V4.0_OS
    • Component/s: JSON Format
    • None
    • Environment:

      [Proposed]

    • Hide

      In Section 4.5, Control information, of the OData JSON format doc.

      Add to the existing sentence:
      "In addition to the “pure data” a message body MAY contain control information that is represented as annotations whose names start with odata followed by a dot."

      the following:

      "Clients should be aware that future versions of OData are expected to allow omitting the odata prefix for control information, and should consider property names prefixed with the "@" symbol, and not containing a dot, to be the same as property names prefixed with "@odata.".

      Show
      In Section 4.5, Control information, of the OData JSON format doc. Add to the existing sentence: "In addition to the “pure data” a message body MAY contain control information that is represented as annotations whose names start with odata followed by a dot." the following: "Clients should be aware that future versions of OData are expected to allow omitting the odata prefix for control information, and should consider property names prefixed with the "@" symbol, and not containing a dot, to be the same as property names prefixed with "@odata.".

      OData control information is represented in a JSON payload as an annotation within the "odata" namespace. However, many services would like to return such control information without specifying the default "odata" namespace. ODATA-630 proposes allowing services to omit the "odata" namespace for OData control information, effectively making OData the default namespace. This would be more consistent with other formats such as JSON-LD.

      It would be nice to make clients aware that this change is likely, to allow them to anticipate it when implementing their V4 implementations.

            Assignee:
            Unassigned
            Reporter:
            Michael Pizzo (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: