[OASIS Issue Tracker] (ODATA-969) Chapter 15, Example 32: syntax of "target" URL

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

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

Michael Pizzo updated ODATA-969:
--------------------------------

    Proposal: Clarify in text that functions are invoked by adding the named parameters as query options. The syntax of the url is up to the service (could be implicit parameters or explicit as in the example)  (was: Clarify prose text:

The target name/value pair contains a bound function or action URL. The target URL SHOULD use implicit parameter aliasing for the function parameters. If the URL in the target name/value pair cannot be used to invoke all overloads for the function, then the function name in the advertisement MUST be distinguished by appending the parentheses-enclosed, comma-separated list of non-binding parameter names. 

Clarify example 

Example 32: full representation of a specific overload

{
  "@odata.context": "http://host/service/$metadata#Employees/$entity";,
  "#Model.RemainingVacation(Year)": {
    "title": "Remaining vacation from year...",
    "target": "Employees(2)/RemainingVacation"
  },
  ...
}

Function can be invoked using implicit parameter aliases:

GET Employees(2)/RemainingVacation?@Year=2015)

> Chapter 15, Example 32: syntax of "target" URL
> ----------------------------------------------
>
>                 Key: ODATA-969
>                 URL: https://issues.oasis-open.org/browse/ODATA-969
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData JSON Format
>    Affects Versions: V4.0_ERRATA03
>         Environment: Proposed
>            Reporter: Ralf Handl
>             Fix For: V4.01_WD01, V4.0_ERRATA04
>
>
> The example shows 
>     "target": "Employees(2)/RemainingVacation(Year=@Year)"
> The prose text says:
> The target name/value pair contains a bound function or action URL. If the URL in the target name/value pair cannot be used to invoke all overloads for the function, then the function name MUST be distinguished by appending the parentheses-enclosed, comma-separated list of non-binding parameter names.
> This implies that the example should show
>     "target": "Employees(2)/RemainingVacation(Year)"
> Problem is that this URL would be quite useless for invoking the function. Also the specific function overload is already identified by the advertisement
>  "#Model.RemainingVacation(Year)": {...}
> If the intention of "target" is to provide a URL for invoking the function, then a better approach would be to build on ODATA-763 and require that "target" is a URL without trailing parens and parameter names that can be invoked by appending the default aliases for the parameters listed in the advertisement.



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