[OASIS Issue Tracker] (ODATA-1567) Clarify "Expand to the level present in the deep insert request"

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

Michael Pizzo created ODATA-1567:
------------------------------------

             Summary: Clarify "Expand to the level present in the deep insert request"
                 Key: ODATA-1567
                 URL: https://issues.oasis-open.org/browse/ODATA-1567
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Improvement
            Reporter: Michael Pizzo


InÂ11.4.2.2Â[Create Related Entities When Creating an Entity,|http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_CreateRelatedEntitiesWhenCreatinganE]Âwe state that:

"If the service responds withÂ201 Created, the response MUST be expanded to at least the level that was present in the deep-insert request."

However, we don't specify what information must be included in that nested response (i.e., do unaffected properties need to be retrieved?) nor whether the entire response must be expanded to the maximum level, or if different elements may be expanded to different levels, based on their depth within the request."

We are finding scenarios where it is hard/expensive to return more data that specified in the request. Since we have since added the ability to specify select/expand on the results of the request, we are fine paying the extra cost to re-query whatever data is required, but doing this by default in order to return a 201 Created seems onerous.

Note that, inÂ11.4.3Â[Update an Entity|http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity], we specify:
"Upon successful completion the service responds with eitherÂ[200 OK|http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_ResponseCode200OK]Âand a representation of the updated entity, orÂ[204 No Content|http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_ResponseCode204NoContent]";

We do not here specify which properties of the representation must be returned (i.e., only the updated properties or all of the properties or some default set of properties or???)



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