Skip to content

Improve doc: In the absence of a nativeType, the constraints recive an array value #2322

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
G0URAB wants to merge 2 commits into
base: 4.3
Choose a base branch
from
Open

Improve doc: In the absence of a nativeType, the constraints recive an array value #2322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38dcd38
Enhance X-Request-ID constraints with nativeType
G0URAB Sep 4, 2026
268e824
Update filters.md for nativeType clarification
G0URAB Sep 4, 2026
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
8 changes: 7 additions & 1 deletion core/filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,8 @@ use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\HeaderParameter;
use ApiPlatform\Metadata\QueryParameter;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\TypeInfo\Type\BuiltinType;
use Symfony\Component\TypeInfo\TypeIdentifier;

#[ApiResource(operations: [
new GetCollection(
Expand All @@ -510,7 +512,8 @@ use Symfony\Component\Validator\Constraints as Assert;
'X-Request-ID' => new HeaderParameter(
description: 'A unique request identifier.',
required: true,
constraints: [new Assert\Uuid()]
constraints: [new Assert\Uuid()],
nativeType: new BuiltinType(typeIdentifier: TypeIdentifier::STRING)
)
]
)
Expand All @@ -521,6 +524,9 @@ class User {}
> [!NOTE] When `castToNativeType` is enabled, API Platform infers type validation from the JSON
> Schema.

If `constraints` are used then a valid type needs to be passed using `nativeType` named argument.
Otherwise, the values will be passed as an array to each constraints.

The `ApiPlatform\Validator\Util\ParameterValidationConstraints` trait can be used to automatically
infer validation constraints from the JSON Schema and OpenAPI definitions of a parameter.

Expand Down
Loading