[OASIS Issue Tracker] (ODATA-1398) Improve text and examples for JSON and multipart batch

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

Ralf Handl created ODATA-1398:
---------------------------------

             Summary: Improve text and examples for JSON and multipart batch
                 Key: ODATA-1398
                 URL: https://issues.oasis-open.org/browse/ODATA-1398
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Improvement
          Components: JSON Format, Protocol
    Affects Versions: V4.01_OS
            Reporter: Ralf Handl
             Fix For: V4.01_ERRATA01


Feedback from Martin Zurmuehl:

1.Â[https://docs.oasis-open.org/odata/odata-json-format/v4.01/cos01/odata-json-format-v4.01-cos01.html#sec_BatchResponse]

Example 50 only shows the body, the other response elements are missing, example 51 is more complete, as is the corresponding example 104 here:Â[https://docs.oasis-open.org/odata/odata/v4.01/cs02/part1-protocol/odata-v4.01-cs02-part1-protocol.html#sec_MultipartBatchResponse]).

2. The normative text doesn't state which HTTP response code to send for synchronous batch responses; for async responses (19.6.) it is explicitly stated. Part 1: Protocol states this explicitly inÂ[https://docs.oasis-open.org/odata/odata/v4.01/cs02/part1-protocol/odata-v4.01-cs02-part1-protocol.html#sec_BatchRequestHeaders]:
{quote}If the set of request headers of a batch request are valid the service MUST return aÂ[200 OK|https://docs.oasis-open.org/odata/odata/v4.01/cs02/part1-protocol/odata-v4.01-cs02-part1-protocol.html#sec_ResponseCode200OK]ÂHTTP response code to indicate that the batch request was accepted for processing, but the processing is yet to be completed. The individual requests within the body of the batch request may subsequently fail or be malformed; however, this enables batch implementations to stream the results.

If the service receives a batch request with an invalid set of headers it MUST return aÂ[4xx response code|https://docs.oasis-open.org/odata/odata/v4.01/cs02/part1-protocol/odata-v4.01-cs02-part1-protocol.html#sec_ClientErrorResponses]Âand perform no further processing of the batch request.
{quote}
However this is (mis)placed under âBatch Request Headersââ.

3. The statement âbut the processing is yet to be completedâ suggests that processing is not finished when sending 200 OK. We should rather say âThe processing can be completed in whole or in part.â



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