[OASIS Issue Tracker] Updated: (ODATA-258) Advertise function imports in service document

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

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

Ralf Handl updated ODATA-258:
-----------------------------

    Proposal: 
1. Define a new boolean attribute to FunctionImport called "IncludeInServiceDocument", valid only on parameterless functions. If present, with a value of "True", the function import is advertised in the service document
2. Define a new kind "FunctionImport", in ATOM and JSON, for exposing parameterless functions
3. Clarify that the service SHOULD NOT expose entitysets that cannot be navigated using only the supplied href.

Examples:

{
  "odata.metadata": "http://host/service/$metadata";,
  "value": [
    { 
      "name": "Orders",
      "kind": "EntitySet"
      "url": "Orders"
    },
    {
      "name": "TopProducts",
      "kind": "Function"
      "url": "TopProducts"
    },
    {
      "name": "Contoso",
      "kind": "Entity"
      "url": "Contoso"
    }
  ]
}

As approved from 2013-2-21 TC meeting:
I move to resolve ODATA-258 as proposed with the addition of also advertising children of non-default entity containers, using workspaces in AtomPub and qualified names in JSON

Accepted: https://www.oasis-open.org/committees/download.php/48346/odata-meeting-26_on-20130221-minutes.html#odata-258

  was:
1. Define a new boolean attribute to FunctionImport called "IncludeInServiceDocument", valid only on parameterless functions. If present, with a value of "True", the function import is advertised in the service document
2. Define a new kind "Function", in ATOM and JSON, for exposing parameterless functions
3. Clarify that the service SHOULD NOT expose entitysets that cannot be navigated using only the supplied href.

Examples:

{
  "odata.metadata": "http://host/service/$metadata";,
  "value": [
    { 
      "name": "Orders",
      "kind": "EntitySet"
      "url": "Orders"
    },
    {
      "name": "TopProducts",
      "kind": "Function"
      "url": "TopProducts"
    },
    {
      "name": "Contoso",
      "kind": "Entity"
      "url": "Contoso"
    }
  ]
}

As approved from 2013-2-21 TC meeting:
I move to resolve ODATA-258 as proposed with the addition of also advertising children of non-default entity containers, using workspaces in AtomPub and qualified names in JSON

Accepted: https://www.oasis-open.org/committees/download.php/48346/odata-meeting-26_on-20130221-minutes.html#odata-258


Changed kind constant "Function" to "FunctionImport" as we have both Function and FunctionImport in CSDL, and this kind of service document entry refers to a FunctionImport.

> Advertise function imports in service document
> ----------------------------------------------
>
>                 Key: ODATA-258
>                 URL: http://tools.oasis-open.org/issues/browse/ODATA-258
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: OData ATOM Format , OData CSDL, OData JSON Format
>    Affects Versions: V4.0_WD01
>         Environment: [Proposed]
>            Reporter: Ralf Handl
>             Fix For: V4.0_WD01
>
>
> The service document is an entry point for hypermedia-driven clients, so function imports that can be called "directly from the service root" should also be advertised.
> Function imports that require a binding parameter don't fall into that category.
> Ideally the advertised function imports would require no parameters to be passed, i.e. only have parameters with default values or no parameters at all, so they behave to GET requests similar to named entities and entity sets.
> As in real life we also encounter entity sets that e.g. respond with errors if queried without a sufficiently selective $filter query parameter, I hesitate to make "only parameters with default values" a requirement for being advertised.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira