OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

odata message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


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


    [ http://tools.oasis-open.org/issues/browse/ODATA-258?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=32542#action_32542 ] 

Ralf Handl edited comment on ODATA-258 at 3/1/13 10:42 AM:
-----------------------------------------------------------

Regarding 3. I see three ways:
 - EntitySet allows IncludeInServiceDocument but has a default value of "true".
 - EntitySet allows IncludeInServiceDocument only for non-default containers, so entity sets not to be advertised can be "hidden" in a different container
 - EntityContainer gets IncludeInServiceDocument attribute with default value of "false", but implicitly true for IsDefaultEntityContainer="true".

Which is better?

Actually there's a fourth option: stick to only advertising the default entity container :-)

After some discussion Mike, Martin and I find the first option the best (or least confusing :-)

      was (Author: ralfhandl):
    Regarding 3. I see three ways:
 - EntitySet allows IncludeInServiceDocument but has a default value of "true".
 - EntitySet allows IncludeInServiceDocument only for non-default containers, so entity sets not to be advertised can be "hidden" in a different container
 - EntityContainer gets IncludeInServiceDocument attribute with default value of "false", but implicitly true for IsDefaultEntityContainer="true".

Which is better?

Actually there's a fourth option: stick to only advertising the default entity container :-)
  
> 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 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

        


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]