openstack/api-sig
Code Issues Proposed changes

Add pagination/filtering topic document

Browse Source
This commit is contained in:
Jay Pipes 2014-10-13 22:03:06 -04:00
parent bead79f947
commit d04cd7c363
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -20,3 +20,4 @@ specific issue:
* [API Discoverability](discoverability.md)
* [Compatibility](compatibility.md)
* [API Extensions](extensions.md)
* [Pagination and Filtering](pagination_filtering.md)

20
pagination_filtering.md Normal file
View File

@ -0,0 +1,20 @@
Pagination and Filtering
========================
This topic document serves to provide guidance on how to handle the pagination of large result sets and the best ways to provide filtering capabilities in a project's public REST API.
Pagination
----------
**TODO** Discuss the methods currently used to paginate in OpenStack APIs.
**TODO** Make a proposal/decision on the recommended way to implement
pagination.
Filtering
---------
**TODO** Discuss the methods currently used to filter in OpenStack APIs.
**TODO** Make a proposal/decision on the recommended way to implement
filtering.