Add advanced filter #108
Merged
Add advanced filter #108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue/Task Number: 107
Closes #107
Overview
This PR adds the new filters introduced in #440 and #486.
Changes
searchTermandsearchTermsFilterableprotocol to which paginated collection can conform in order to generateFilterParams.Implementation Details
The implementation follows the advanced filtering guide and provide some helpers to simplify filter creation.
Each filterable resources now have a predefined set of filterable fields to make it easier for the developers to filter simple relations. However we still allow a more advanced filtering where developers can specify the field path as a string.
Usage
The full usage is documented in this documentation file.
Impact
searchTermandsearchTermsare now removed and developers need to conform to the new filtering system.