[Filter] documention of enums on custom filters doesn't work anymore

[remoteclient]

API Platform version(s) affected: 2.5.9

Description
Given is this definition in a custom filter:

    public function getDescription(string $resourceClass): array
    {
        if (!$this->properties) {
            return [];
        }

        $description = [];
        foreach ($this->properties as $property => $strategy) {
            $description[$property] = [
                'property' => $property,
                'type' => 'string',
                'required' => false,
                'openapi' => [
                    'description' => 'Filter leads by state',
                    'name' => 'LeadStateFilter',
                    'type' => 'string',
                    'enum' => ['new', 'archived', 'anonymized'],
                ],
            ];
        }

        return $description;
    }

The enum isn't showing up on swagger anymore. This used to work in the past. I did not realize when it stopped working.

How to reproduce
Try setting an enum like above in a custom filter description.

[darkcattz]

Hello,

Same problem.
What is the new format to use for update the openapi doc for custom filters ?
I unfortunately do not see anything in the documentation.

Thanks

[robertfausk]

There is a PR in the core for this:
#3007

Regarding your example you can use:

    public function getDescription(string $resourceClass): array
    {
        if (!$this->properties) {
            return [];
        }

        $description = [];
        foreach ($this->properties as $property => $strategy) {
            $description[$property] = [
                'property' => $property,
                'type' => 'string',
                'required' => false,
                'description' => 'Filter leads by state',
                'schema' => [
                    'type' => 'string',
                    'enum' => ['new', 'archived', 'anonymized'],
                ],
            ];
        }

        return $description;
    }

...respectively have a closer look at the PR mentioned above.

[ahmed-bhs]

@robertfausk do you think that throwing an invalid argument could be a good idea when the client provides a query that not belong to one of the enums values ['new', 'archived', 'anonymized'] ?

[remoteclient]

@robertfausk do you think that throwing an invalid argument could be a good idea when the client provides a query that not belong to one of the enums values ['new', 'archived', 'anonymized'] ?

I would throw a validation error.

[soyuka]

Fixed in 8e9e8a6 — the filter description schema key (including enum) is now merged into the OpenAPI parameter schema (src/OpenApi/Factory/OpenApiFactory.php), covered by OpenApiFactoryTest. Verified on current 4.3 HEAD. Closing as fixed.