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

Define by-value/reference expectations for action/function payloads.

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.01_CSD03
    • Fix Version/s: V4.01_CS01
    • Component/s: Protocol
    • Labels:
      None
    • Environment:

      Applied/Approved/Closed

    • Proposal:
      Hide

      Expectations to be spelled out in Part 1: Protocol, documenting the by-value/by-reference expectations in Part 1: Protocol, with forward-reference to JSON Format for "bind syntax" / "entity references", to be detailed by authors, to be reviewed in document walk-through

      Show
      Expectations to be spelled out in Part 1: Protocol, documenting the by-value/by-reference expectations in Part 1: Protocol, with forward-reference to JSON Format for "bind syntax" / "entity references", to be detailed by authors, to be reviewed in document walk-through
    • Resolution:
      Show
      https://www.oasis-open.org/committees/download.php/62018/odata-v4.01-wd04-part1-protocol-2017-11-13-redlined.docx

      Description

      Descriptions of parameters and return types do not explain expectations for references to Entities.
      The metamodel + vocabulary for CSDL allows three types of encodings:
      • By-reference, represented as a string containing a URL that references the resource.
      • By-reference, represented as an object containing a partial copy of the resource that includes just the @odata.id meta property with a value that is a string containing a URL that references the resource.
      • By-value, represented as an object containing a copy of the resource.

      For parameters and return-types, the question is which of these are expected in a payload.

        Attachments

          Activity

            People

            • Assignee:
              mikep Michael Pizzo
              Reporter:
              george.ericson George Ericson
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: