[OASIS Issue Tracker] (ODATA-1125) Define by-value/reference expectations for action/function payloads.

From
OASIS Issues Tracker <>
Date
2017-10-26T15:43:58+00:00
ID
Thread
[OASIS Issue Tracker] (ODATA-1125) Define by-value/reference expectations for action/function payloads.
[ https://issues.oasis-open.org/browse/ODATA-1125?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=67941#comment-67941 ] 

Ralf Handl commented on ODATA-1125:
-----------------------------------

From TC discussion on 2017-10-26:

Expectations:
- binding parameter by reference via URL preceding action/function
- non-binding primitive and complex by value in action request body
- non-binding (collection-valued) parameters of entity type:
- by reference using { "@id": ... }
- by value using object notation with literal property values

"by reference" syntax for entities defined in JSON Format, add forward reference

> Define by-value/reference expectations for action/function payloads.
> --------------------------------------------------------------------
>
>                 Key: ODATA-1125
>                 URL: https://issues.oasis-open.org/browse/ODATA-1125
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: CSDL JSON , CSDL XML, Protocol
>    Affects Versions: V4.01_CSD03
>         Environment: Schema and protocol 
>            Reporter: George Ericson
>             Fix For: V4.01_CS01
>
>
> 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.



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