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

Support annotations for expanded references

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_ERRATA02
    • Fix Version/s: V4.0_ERRATA03
    • Component/s: Vocabularies
    • Labels:
      None
    • Environment:

      [Proposed]

    • Proposal:
      Hide

      Add two new annotations, applied to navigation link elements: "AutoExpandReferences" and "AutoExpand".

      AutoExpandReferences says that the default behavior of the service is to expand just the references of the related resources, and AutoExpand says the default behavior of the service is to expand the related resources.

      Such services may or may not support expand on those navigation properties

      Applied: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/vocabularies/Org.OData.Core.V1.xml?rev=674

      Show
      Add two new annotations, applied to navigation link elements: "AutoExpandReferences" and "AutoExpand". AutoExpandReferences says that the default behavior of the service is to expand just the references of the related resources, and AutoExpand says the default behavior of the service is to expand the related resources. Such services may or may not support expand on those navigation properties Applied: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/vocabularies/Org.OData.Core.V1.xml?rev=674

      Description

      In OData V4 we have added the concept of fetching related references through appending /$ref to the navigation. This returns a result semantically more similar to RDF, which returns ids of related elements.

      Some services, particularly in constrained environments, may be only be able to return the keys of related references. These services push the burden of the work on the client to build the graph from the individual pieces.

      In other cases, especially for small nested/contained results, the service might only be able to represent the related elements as expanded relationships.

      We already support both of these representations, and having services return them in this format (even without an expand) is legal, but we don't have a way to tell the client that the service does this by default and may not support expand.

      We should recognize such services exist and provide a way to tell clients of this behavior.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              mikep Michael Pizzo
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: