`property` field of FilterInterface::getDescription - string only? about core

[soyuka]

Interesting, yeah it's a shame and I tried to move the getDescription forward by documenting it in the last release.

property is mainly used for https://www.hydra-cg.com/spec/latest/core/#templated-links and in the specification it is typed string, and I recently added the php doc:

core/src/Metadata/FilterInterface.php

Line 56 in e867d07

* @return array<string, array{property?: string, type?: string, required?: bool, description?: string, strategy?: string, is_collection?: bool, swagger?: array<string, mixed>, openapi?: array<string, mixed>|\ApiPlatform\OpenApi\Model\Parameter, schema?: array<string, mixed>}>

In another change we now consider this as a string:

core/src/Hydra/Serializer/CollectionFiltersNormalizer.php

Line 178 in e867d07

$k = str_replace(':property', $description['property'], $key);

Actually your filter should return an array per property supported:

$description = ['type' => SearchFilterInterface::STRATEGY_PARTIAL,
                'required' => false,
                'schema' => ['type' => 'string']];
return ['firstName' => ['property' => 'firstName'] + $description, 'lastName' => ['property' => 'lastName'] + $description, 'middleName' => ['property' => 'middleName'] + $description]; 

Not sure it had any impact earlier on, let me know if this leads to issues elsewhere.

[ostrolucky]

I think I cannot do this, because key should be name of the query parameter, which in my case is name. When consumer does ?name=foo, filter will do firstName LIKE '%foo%' OR lastName LIKE '%foo%' OR middleName LIKE '%foo%', hence I documented ['name' => ['property' => ['firstName', 'lastName', 'middleName']],. If I split this to 3 filters with different key, this would indicate to consumer that they can do ?firstName=foo, ?lastName=foo, ?middleName=foo instead of ?name=foo, wouldn't it?

[soyuka]

Yes indeed, I think I had a discussion with someone recently about this (probably at #5995 but can't find where). I think that what would be best would be to not set the property in your case as it has an impact only on the documentation.

[ostrolucky]

Ok then removing it is! Thanks for being reactive. I guess this is something we would have to address to folks making the standard itself?

[soyuka]

You mean hydra? Yeah I'm on the mailing list but it's quite cold for now :/.