You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: core/filters.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -600,7 +600,7 @@ Given that the collection endpoint is `/books`, you can filter by serialization
600
600
601
601
### Property filter
602
602
603
-
The property filter adds the possibility to filter serialization properties.
603
+
The property filter adds the possibility to select the properties to serialize (sparse fieldsets).
604
604
605
605
Syntax: `?properties[]=<property>`
606
606
@@ -630,9 +630,9 @@ class Book
630
630
```
631
631
632
632
Three arguments are available to configure the filter:
633
-
- `parameterName`is the query parameter name (default `groups`)
633
+
- `parameterName`is the query parameter name (default `properties`)
634
634
- `overrideDefaultProperties`allows to override the default serialization properties (default `false`)
635
-
- `whitelist`properties whitelist to avoid uncontrolled data exposure (default `null` to allow all groups)
635
+
- `whitelist`properties whitelist to avoid uncontrolled data exposure (default `null` to allow all properties)
636
636
637
637
Given that the collection endpoint is `/books`, you can filter the serialization properties with the following query: `/books?properties[]=title&properties[]=author`.
0 commit comments