[jira] [Updated] (AMBARI-2647) API Docs : Update docs to include pagination.

["Tom Beerbower (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/AMBARI-2647?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom Beerbower updated AMBARI-2647:
----------------------------------

    Attachment: AMBARI-2647.patch
    
> API Docs : Update docs to include pagination.
> ---------------------------------------------
>
>                 Key: AMBARI-2647
>                 URL: https://issues.apache.org/jira/browse/AMBARI-2647
>             Project: Ambari
>          Issue Type: Bug
>            Reporter: Tom Beerbower
>            Assignee: Tom Beerbower
>         Attachments: AMBARI-2647.patch
>
>
> Update docs with first cut of pagination changes ...
> {code}
> Parameter        Description
> ============================
> page_size        the number of resources to be returned for the paged response
> from             the starting page resource (inclusive).  Valid values are 'start' | <offset>
> to               the ending page resource (inclusive).  Valid values are 'end' | <offset>
> Either from or to should be specified, not both.  If neither is specified then 'from=start' is assumed.
> <offset> is an integer value that represents an offset (zero based) into the set of resources.  For example, '&from=7' means that the first resource of the response page should be the 7th resource of the resource set.
> 'start' indicates an offset of 0.
> 'end' indicates an offset of the end of the set of resources.
> Default ordering (by key properties) is implied.
> {code}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira