[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=32161#action_32161 ] 

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

Section 6.5 provides for  SelectAttr=attr1,attr2  as a way to pick certain fields.  We may wish to extend that section to accommodate the additional requests.  (And change SelectAttr to "attributes" to offer a consistent API.)

Draft Proposal - support the following query parameters and values

  ?return=map    (the default)
  ?return=attributes   (list of matching attributes only)
  ?return=value         (value only; only permitted if there is a single attribute applicable)
  ?return=values       (list of values)

  ?attributes=a,b,c    (these attributes, in order)
  ?attribute=a           (just one attribute)
  ?attributeGlob=a*   (everything matching glob a*)
  ?attributeRegex=a.*  (everything matching regex a.*)

  ?limit=N    (return a data structure truncated at N items, dropping those beyond N, where items are entries in a map or list, or characters in a string (this latter one would be useful e.g. to tail a log file)
  ?start=N  (drop the first N items; can be used in conjunction with limit, where the index=N truncation is done first; if N<0 then truncate all but the last N items)


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