[OASIS Issue Tracker] (ODATA-1424) OData 4.01 JSON "Delta Responses" doesn't describe use of "@id" (or "@odata.id") for Added/Changed Entity

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

Evan Ireland created ODATA-1424:
-----------------------------------

             Summary: OData 4.01 JSON "Delta Responses" doesn't describe use of "@id" (or "@odata.id") for Added/Changed Entity
                 Key: ODATA-1424
                 URL: https://issues.oasis-open.org/browse/ODATA-1424
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Bug
    Affects Versions: V4.01_OS
            Reporter: Evan Ireland


https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_AddedChangedEntity

Text states:

* Added entities MUST include all available selected properties and MAY include additional, unselected properties. Collection-valued properties are treated as atomic values; any collection-valued properties returned from a delta request MUST contain all current values for that collection.

* Changed entities MUST include all available selected properties that have changed, and MAY include additional properties.

Nowhere in the prose does it state that "id" control information *must* be included for added/changed entities (as compared with, in particular, providing the key properties). The non-normative example 32 shows the use of "@id" (V4.01) for a changed entity. There aren't any examples for added entities.

Contrast this with section 15.3 Deleted Entity:

"In OData 4.01 payloads the deleted-entity object MUST include the following properties, regardless of the specified metadata value: ... Control information id or all of the entityâs key fields."

For consistency between added/changed entities and deleted entities, perhaps added/changed entities could similarly require: "Control information id or all of the entityâs key fields".




--
This message was sent by Atlassian Jira
(v8.3.3#803004)