Fix filtering on private api routes#35
Draft
godismyjudge95 wants to merge 1 commit into
Draft
Conversation
Contributor
|
I've tested this PR by applying it as a patch locally, and can confirm:
This works for me! |
This file contains hidden or 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
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.
Currently filtering does not work because none of the controllers implement the required allowedFilters method:
https://github.com/statamic/cms/blob/5.x/src/Http/Controllers/API/ApiController.php#L132-L134
Which means all filters are just discarded.
This PR adds in a simplified version of Statamic core's method:
https://github.com/statamic/cms/blob/5.x/src/Http/Controllers/API/UsersController.php#L39-L44
to the VerifiesPrivateAPI trait.
To enable filtering one can follow the steps outlined in the Statamic docs - https://statamic.dev/rest-api#enabling-filters
But make the changes specified to the
config/private-api.phpfile instead ofconfig/statamic/api.phpSetting this to draft as I plan to implement this for all the controllers unless that is not desired.