docs: add new search filters syntax and the new make filter command#2203
Merged
vinceAmstoutz merged 6 commits intoapi-platform:mainfrom Sep 15, 2025
Conversation
The `ApiFilter` attribute is deprecated and scheduled for removal in API Platform 5.0. This commit updates the documentation to strongly recommend the modern `QueryParameter` syntax. This new approach offers better flexibility and more explicit, per-operation filter configuration. The examples have been updated to reflect this best practice.
Document the newly introduced search filters (`IriFilter`, `ExactFilter`, `PartialSearchFilter`, `FreeTextQueryFilter`, `OrFilter`) and clarify the deprecation of the `SearchFilter`. Encourage users to migrate to `QueryParameter` attributes for better configurability and explicitness.
vinceAmstoutz
changed the title
soyuka
reviewed
Sep 12, 2025
vinceAmstoutz
force-pushed
the
docs/add-doc-for-new-filters-synthax-with-query-parameter-and-make-filter-commands
branch
from
f0c6735 to
9e83ed0
Compare
Add notes on automatic validation benefits and reference `ParameterValidatorProvider` for Symfony and Laravel. Clarify the usage of `ParameterExtension` for handling empty values in Doctrine ORM.
Member
Author
|
Saw it with Soyuka via message, it's okay to merge. |
vinceAmstoutz
deleted the
docs/add-doc-for-new-filters-synthax-with-query-parameter-and-make-filter-commands
branch
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
2 participants
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.
Adds documentation for api-platform/core#7121, api-platform/core#7364 and api-platform/core#7355.
Also fixes #2202