Non singleValue value objects as query parameters are not handled correctly yet

[mficzel]

If a value object is used as query parameter the generated openapi spec will lead swagger ui to pass each property ob the value object as single parameter.

VO

final readonly class Person
{
    public function __construct(
        public string $firstName,
        public string $lastName,
    ) {
    }
}

controller action

    public function personAction(
        Person $person
    ): PersonResponse {
    }

generated ur by swagger ui: path?firstName=foo&lastName=bar
expected uri: path?person[firstName]=foo&person[lastName]=bar | path?person={"firstName":"foo", "lastName":"bar"}

I am pretty sure the generated uris are not correct but cannot say which of the correctish ones should be expected.

[mficzel]

from: https://swagger.io/docs/specification/v3_0/serialization/?sbsearch=deepObject

deepObject – simple non-nested objects are serialized as paramName[prop1]=value1&paramName[prop2]=value2&.... The behavior for nested objects and arrays is undefined.

So we get the behavior of php but only for objects and the direct properties ... deeper nesting is not supported by default.

[mficzel]

Also see related discussions in Swagger / OpenAPI:

1. Support deep objects for query parameters with deepObject style swagger-api/swagger-js#1385
2. Support deep objects for query parameters with deepObject style OAI/OpenAPI-Specification#1706
3. Support for arbitrary query strings OAI/OpenAPI-Specification#1502