[OASIS Issue Tracker] (ODATA-795) Support annotations for expanded references

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

     [ https://issues.oasis-open.org/browse/ODATA-795?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Pizzo updated ODATA-795:
--------------------------------

    Proposal: 
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

  was:
Add two new annotations, applied to navigation link elements: "ExpandReferences" and "ExpandResources".

ExpandReferences says that the default behavior of the service is to expand just the references of the related resources, and ExpandResources 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.


> Support annotations for expanded references
> -------------------------------------------
>
>                 Key: ODATA-795
>                 URL: https://issues.oasis-open.org/browse/ODATA-795
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData CSDL
>    Affects Versions: V4.0_ERRATA02
>         Environment: [Proposed]
>            Reporter: Michael Pizzo
>             Fix For: V4.0_ERRATA03
>
>
> 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.



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)