fix #2196

soyuka · soyuka · commit acaf29cd81b1 · 2025-09-05T15:42:24.000+02:00
diff --git a/core/filters.md b/core/filters.md
@@ -123,7 +123,7 @@ use ApiPlatform\Metadata\QueryParameter;
     new GetCollection(
         parameters: [
             'search[:property]' => new QueryParameter(
-                filter: new SearchFilter(properties: ['title' => 'partial', 'description' => 'partial'])
+                filter: 'api_platform.doctrine.orm.search_filter.instance'
             )
         ]
     )
@@ -149,6 +149,8 @@ public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $q
 }
 ```
 
+Note that we're using `api_platform.doctrine.orm.search_filter.instance` (exists also for ODM). Indeed this is a special instance of the search filter where `properties` can be changed during runtime. This is considered as "legacy filter" below, in API Platform 4.0 we'll recommend to create a custom filter or to use the `PartialSearchFilter`.
+
 ### Restricting Properties with `:property` Placeholders
 
 There are two different approaches to property restriction depending on your filter design:

Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ use ApiPlatform\Metadata\QueryParameter;`
`123`	`123`	`new GetCollection(`
`124`	`124`	`parameters: [`
`125`	`125`	`'search[:property]' => new QueryParameter(`
`126`		`- filter: new SearchFilter(properties: ['title' => 'partial', 'description' => 'partial'])`
	`126`	`+ filter: 'api_platform.doctrine.orm.search_filter.instance'`
`127`	`127`	`)`
`128`	`128`	`]`
`129`	`129`	`)`
`@@ -149,6 +149,8 @@ public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $q`
`149`	`149`	`}`
`150`	`150`	```
`151`	`151`
	`152`	+Note that we're using `api_platform.doctrine.orm.search_filter.instance` (exists also for ODM). Indeed this is a special instance of the search filter where `properties` can be changed during runtime. This is considered as "legacy filter" below, in API Platform 4.0 we'll recommend to create a custom filter or to use the `PartialSearchFilter`.
	`153`	`+`
`152`	`154`	### Restricting Properties with `:property` Placeholders
`153`	`155`
`154`	`156`	`There are two different approaches to property restriction depending on your filter design:`