Skip to content

docs: document invalid IRI parameter option #2369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pysocrates wants to merge 1 commit into
base: 5.0
Choose a base branch
from
Open

docs: document invalid IRI parameter option #2369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions core/filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,6 +751,23 @@ The `IriConverterParameterProvider` supports the following options in `extraProp

- **`fetch_data`**: Boolean (default: `false`) - When `true`, forces the IRI converter to fetch the
actual entity data instead of just creating a reference.
- **`throw_invalid_argument`**: Boolean (default: `false`) - When `true`, propagate invalid IRI
exceptions instead of logging them. With the default Symfony exception mapping, this returns HTTP
400. This applies to both single IRIs and arrays.
- **`throw_not_found`**: Boolean (default: `false`) - When `true`, propagate exceptions for resources
that cannot be found. Use `fetch_data: true` when the converter must check that the resource exists.

For example, to reject malformed IRIs in an `IriFilter` parameter:

```php
use ApiPlatform\Doctrine\Orm\Filter\IriFilter;
use ApiPlatform\Metadata\QueryParameter;

new QueryParameter(
filter: new IriFilter(),
extraProperties: ['throw_invalid_argument' => true],
)
```

### `ReadLinkParameterProvider`

Expand Down
Loading