22 Filtering
This chapter covers
- Why standard list methods should support filtering resources
- How to communicate a filter expression as part of the standard list request
- Guidelines for behavior when filtering resources
- Functionality that should and should not be supported in filter conditions
While the standard list method provides a mechanism to iterate through a complete set of resources in an API, so far we really don’t have a way to indicate an interest in only a subset of those resources. This pattern will explore using a special field on the standard list request as a way to filter the full data set to return only a matching result set. Additionally, we’ll get into the details of how to structure input values for this special filtering ...
Get API Design Patterns now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
