Skip to content

Conversation

vinceAmstoutz
Copy link
Member

@vinceAmstoutz vinceAmstoutz commented Sep 12, 2025

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 vinceAmstoutz self-assigned this Sep 12, 2025
@vinceAmstoutz vinceAmstoutz changed the title Docs/add doc for new filters synthax with query parameter and make filter commands docs: add new search filters syntax and the new make filter command Sep 12, 2025
@vinceAmstoutz vinceAmstoutz force-pushed the docs/add-doc-for-new-filters-synthax-with-query-parameter-and-make-filter-commands branch from f0c6735 to 9e83ed0 Compare September 12, 2025 15:05
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.
@vinceAmstoutz
Copy link
Member Author

Saw it with Soyuka via message, it's okay to merge.

@vinceAmstoutz vinceAmstoutz merged commit 1ce6135 into api-platform:main Sep 15, 2025
1 check passed
@vinceAmstoutz vinceAmstoutz deleted the docs/add-doc-for-new-filters-synthax-with-query-parameter-and-make-filter-commands branch September 15, 2025 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants