From d04cd7c363784bc3288564c0bd7538dfd944dda6 Mon Sep 17 00:00:00 2001 From: Jay Pipes Date: Mon, 13 Oct 2014 22:03:06 -0400 Subject: [PATCH] Add pagination/filtering topic document --- README.md | 1 + pagination_filtering.md | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 pagination_filtering.md diff --git a/README.md b/README.md index 292a4f3..482c364 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,4 @@ specific issue: * [API Discoverability](discoverability.md) * [Compatibility](compatibility.md) * [API Extensions](extensions.md) +* [Pagination and Filtering](pagination_filtering.md) diff --git a/pagination_filtering.md b/pagination_filtering.md new file mode 100644 index 0000000..eed0ca7 --- /dev/null +++ b/pagination_filtering.md @@ -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.