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

Clarify applicability of $expand options

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.01_OS
    • Fix Version/s: V4.01_ERRATA01
    • Component/s: Protocol, URL Conventions
    • Labels:
      None
    • Environment:

      proposed

    • Proposal:
      Hide

      Protocol spec:

      • Add to section 11.2.5.2.1 Expand Options: Allowed system query options are $select, $expand, and $compute, as well as $filter, $orderby, $skip, $top, $count, $search, and $levels for collection-valued navigation properties.
      • Rephrase section 11.2.5.2.1.1     Expand Option $levels: "All provided expand options except $levels are applied ..."

       

      URL conventions spec:
      Allowed system query options are $select, $expand, and $compute, as well as $filter, $orderby, $skip, $top, $count, $search, and $levels for collection-valued navigation properties.

      Show
      Protocol spec: Add to section 11.2.5.2.1 Expand Options : Allowed system query options are $select, $expand, and $compute, as well as $filter, $orderby, $skip, $top, $count, $search, and $levels for collection-valued navigation properties. Rephrase section  11.2.5.2.1.1     Expand Option $levels : "All provided expand options except $levels are applied ..."   URL conventions spec: Allowed system query options are $select, $expand, and $compute, as well as $filter, $orderby, $skip, $top, $count, $search, and $levels for collection-valued navigation properties.

      Description

      In the protocol specification, section 11.2.5.2.1 Expand Options lists applicable system query options without considering whether a single-valued or a collection-valued navigation property is expanded. In section 11.2.5.2.1.1     Expand Option $levels  the statement that "same expand options are applied at each level of the hierarchy" is obviously not completely true. It has to be "all but $levels".

      The URL conventions specification is not in sync: Section 5.1.3 System Query Option $expand, in the text after example 115, lists only a subset of the allowed system query options.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              gerald.krause1 Gerald Krause
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: