Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-868

Describe HTTP encoding for streamed requests and responses

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_ERRATA02
    • Fix Version/s: V4.01_CS02
    • Component/s: JSON Format, Protocol
    • Labels:
      None
    • Environment:

      Applied

    • Proposal:
      Hide

      The server MUST leave the response as malformed (otherwise there is no way to portably assume the client can detect the error). So, invalid JSON must be returned.

      The easiest way to handle this is for the server to stop serializing the response body.

      The server MAY include information on the source of the error by including a trailing header (available in HTTP/1.1 chunked encoding and in HTTP/2) with name odata-error whose value is a header-encoded OData JSON error object.

      Show
      The server MUST leave the response as malformed (otherwise there is no way to portably assume the client can detect the error). So, invalid JSON must be returned. The easiest way to handle this is for the server to stop serializing the response body. The server MAY include information on the source of the error by including a trailing header (available in HTTP/1.1 chunked encoding and in HTTP/2) with name odata-error  whose value is a header-encoded OData JSON error object.
    • Resolution:
      Hide

      https://github.com/oasis-tcs/odata-abnf/pull/4 

      https://www.oasis-open.org/committees/download.php/64119/odata-v4.01-wd06-part1-protocol-2018-10-19.docx

      https://www.oasis-open.org/committees/download.php/64120/odata-json-format-v4.01-wd06-2018-10-19.docx 

      Show
      https://github.com/oasis-tcs/odata-abnf/pull/4   https://www.oasis-open.org/committees/download.php/64119/odata-v4.01-wd06-part1-protocol-2018-10-19.docx https://www.oasis-open.org/committees/download.php/64120/odata-json-format-v4.01-wd06-2018-10-19.docx  

      Description

      OData JSON Format has a format parameter for streaming scenarios but does not describe how these messages should be encoded.

      Part 1: Protocol, section 9.4 talks about in-stream errors in a format-independent way. Unfortunately we don't define how these should be represented in the JSON format.

      Situations where in-stream errors can occur include

      • metadata requests in XML or JSON
      • data request in JSON or XML
      • media resource requests with any content-type

        Attachments

          Activity

            People

            • Assignee:
              hubert.heijkers Hubert Heijkers
              Reporter:
              handl Ralf Handl
            • Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: