feat(validator): uuid/ulid parameter validation

[aaa2000]

Q	A
Branch	main for features
License	MIT

Adds Symfony validation constraints (Uuid or Ulid) to query parameters whose OpenAPI schema specifies format: uuid or format: ulid

• Validate the uuid with default strict mode https://symfony.com/doc/current/reference/constraints/Uuid.html#strict
• Does not allow validation of a specific version of the UUID https://symfony.com/doc/current/reference/constraints/Uuid.html#versions
• Validate only ULID in the base32 format https://symfony.com/doc/current/reference/constraints/Ulid.html#format

[soyuka]

I'll fix the CI on the main branch asap.

[aaa2000]

I think the PR requires changes because the uuid constraint is not add when the UuidFilter is used because the following schema is not supported

{
    "oneOf": [
        {
            "type": "string",
            "format": "uuid"
        },
        {
            "type": "array",
            "items": {
                "type": "string",
                "format": "uuid"
            }
        }
    ]
}

Filtering by an invalid uuid should return a 422 response and not a 400 response

https://github.com/api-platform/core/blob/main/tests/Functional/Uuid/UuidFilterBaseTestCase.php#L151C55-L151C71

[soyuka]

sure let me know when I should review

[aaa2000]

@soyuka ready for review

Filter by invalid uuid

curl -X 'GET' \
  'http://127.0.0.1:8000/symfony_uuid_devices?page=1&itemsPerPage=3&id=invaliduuid' \ 
  -H 'accept: application/ld+json'

{"@context":"\/contexts\/ConstraintViolation","@id":"\/validation_errors\/f27e6d6c-261a-4056-b391-6673a623531c","@type":"ConstraintViolation","status":422,"violations":[{"propertyPath":"id","message":"This value should satisfy at least one of the following constraints: [1] This value is not a valid UUID. [2] Each element of this collection should satisfy its own set of constraints.","code":"f27e6d6c-261a-4056-b391-6673a623531c"}],"detail":"id: This value should satisfy at least one of the following constraints: [1] This value is not a valid UUID. [2] Each element of this collection should satisfy its own set of constraints.","type":"\/validation_errors\/f27e6d6c-261a-4056-b391-6673a623531c","hydra:description":"id: This value should satisfy at least one of the following constraints: [1] This value is not a valid UUID. [2] Each element of this collection should satisfy its own set of constraints.","hydra:title":"An error occurred"} 

Filter by many invalid uuid

curl -X 'GET' \                                                 
  'http://127.0.0.1:8000/symfony_uuid_devices?page=1&itemsPerPage=3&id[]=invaliduuid&id[]=fsdfsdfs' \
  -H 'accept: application/ld+json'

{"@context":"\/contexts\/ConstraintViolation","@id":"\/validation_errors\/f27e6d6c-261a-4056-b391-6673a623531c","@type":"ConstraintViolation","status":422,"violations":[{"propertyPath":"id","message":"This value should satisfy at least one of the following constraints: [1] This value should be of type string. [2] Each element of this collection should satisfy its own set of constraints.","code":"f27e6d6c-261a-4056-b391-6673a623531c"}],"detail":"id: This value should satisfy at least one of the following constraints: [1] This value should be of type string. [2] Each element of this collection should satisfy its own set of constraints.","type":"\/validation_errors\/f27e6d6c-261a-4056-b391-6673a623531c","hydra:description":"id: This value should satisfy at least one of the following constraints: [1] This value should be of type string. [2] Each element of this collection should satisfy its own set of constraints.","hydra:title":"An error occurred"}

[Copilot]

Pull request overview

This PR adds UUID and ULID validation support to API Platform's parameter validation system. When query or header parameters specify format: uuid or format: ulid in their OpenAPI schema, Symfony's Uuid and Ulid validation constraints are automatically applied.

Changes:

• Added UUID/ULID validation constraints for string parameters with uuid/ulid format specifications
• Updated test assertions to expect HTTP 422 (Unprocessable Entity) instead of 400 (Bad Request) for invalid UUID inputs
• Added test coverage for both single and array UUID/ULID parameter validation in query and header contexts

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
src/Validator/Util/ParameterValidationConstraints.php	Implements validation logic for uuid/ulid formats in both single values and oneOf array scenarios
tests/Functional/Uuid/UuidFilterBaseTestCase.php	Updates expected status codes from 400 to 422 for invalid UUID validation failures
tests/Functional/Parameters/ParameterTest.php	Adds test cases for valid and invalid UUID/ULID values in both query and header parameters
tests/Fixtures/TestBundle/ApiResource/WithParameter.php	Adds API resource configurations for testing UUID/ULID parameters in queries and headers

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.