Skip to content

Commit 66f9ce9

Browse files
authored
Fix PropertyFilter docs
1 parent 7100e39 commit 66f9ce9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

core/filters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,7 @@ Given that the collection endpoint is `/books`, you can filter by serialization
600600

601601
### Property filter
602602

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).
604604

605605
Syntax: `?properties[]=<property>`
606606

@@ -630,9 +630,9 @@ class Book
630630
```
631631

632632
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`)
634634
- `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)
636636

637637
Given that the collection endpoint is `/books`, you can filter the serialization properties with the following query: `/books?properties[]=title&properties[]=author`.
638638

0 commit comments

Comments
 (0)