[OASIS Issue Tracker] Commented: (CAMP-42) Spec should say how to limit/specify the scope of returned data

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

    [ http://tools.oasis-open.org/issues/browse/CAMP-42?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=32274#action_32274 ] 

Alex Heneveld commented on CAMP-42:
-----------------------------------

Good points.

The critical problem which needs to be resolved is that the entry point to CAMP -- Platform -- currently returns _all_ platform components, application components, etc.  Which means a REST client cannot do _anything_ without downloading a potentially very large blob.

I think we should change the spec so that each of those lists is exposed at a link rather than in the body.  That diminishes the urgency of filtering, pagination, and changing return type.

Beyond that I am sympathetic to JAQL (Jacques's suggestion) but that in its entirety is a large burden, and furthermore it is a WIP, so not practical in my view.  (Also there is the question of a normalised specification reference.)  We could pick a subset and align with it, describing it in the CAMP spec instead of the syntax currently proposed for this issue.  (Tobias suggestion #3.)

For pagination, the OpenStack model Adrian references is one I like a lot.  It requires a change to the list structures as currently in the CAMP spec so that we have the 'next' links.  I'm on the fence whether to do that, or use a simple start/limit mechanism, or defer this.


> Spec should say how to limit/specify the scope of returned data
> ---------------------------------------------------------------
>
>                 Key: CAMP-42
>                 URL: http://tools.oasis-open.org/issues/browse/CAMP-42
>             Project: OASIS Cloud Application Management for Platforms (CAMP) TC
>          Issue Type: Task
>          Components: Spec
>            Reporter: Alex Heneveld
>            Assignee: Alex Heneveld
>
> Currently the spec only dictates requests whose response is an entire Resource object.  These Resources could be very large however, and it is wasteful for everyone to send the entire object if, as will commonly be the case I expect, the client is only interested in a small piece of the Resource.
> This spec should define how a client can restrict a query to selected items of the Resource.  This should include:
> * filtering: selecting a specific key or restricting to a set of keys
> * pagination: selecting a specific element or range of elements (where a key's value is of type list)

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