OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

odata message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: [OASIS Issue Tracker] (ODATA-708) Clarify inclusion of @odata.id if key fields are not selected

Michael Pizzo created ODATA-708:

             Summary: Clarify inclusion of @odata.id if key fields are not selected
                 Key: ODATA-708
                 URL: https://issues.oasis-open.org/browse/ODATA-708
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Bug
          Components: OData JSON Format
    Affects Versions: V4.0_OS
         Environment: [Proposed]
            Reporter: Michael Pizzo
             Fix For: V4.0_ERRATA01

In minimal metadata the service omits metadata that can be derived by the client from the payload based on convention, which implies that metadata must be included if it cannot be derived from the payload based on convention. However, in the rules for including @odata.id we don't explicitly mention that the id, which can only be computed if key properties are included in the payload, is thus returned if any key properties are omitted from the response.

This is bad, because if services don't realize they need to include the key fields in this case it will cause clients to be unable to track entities (for example, in doing a merge). Even worse, in delta responses the payload for an updated entity is only required to include changed properties, so if the keys haven't changed (which, by definition, they can't) and the service omits them, the client has no way to correlate the change with the original entity. 

Also, the existing rules omit the case for odata.metadata=none.

This message was sent by Atlassian JIRA

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]