You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
API Platform version(s) affected: 3.1.6 (Schema-generator version 5.2.0)
Description
The groups parameter no longer generates Groups attribute for properties as stated in the documentation.
How to reproduce
The below config (excess removed) describes a referral resource that has one property person. A Person has one property email. The normalization context of the post collection endpoint for Referral has the serialization group set to "referral:post:write" (this works as expected). The email property on Person has the groups option set to referral:post:write such that a person entity can be created from the Referral collection post resource.
Outcome:
When generating this schema, the groups option on Person is ignored. Looking through the code, it looks like the option is defined, but never used. This functionality used to work in version 4.0.1 through ApiPlatform\SchemaGenerator\AttributeGenerator\SerializerGroupsAttributeGenerator. This functionality seems like it's no longer available, though it's still referenced in the documentation. Possible Solution
It is possible to set the Groups attribute using the attributes option, but this is a workaround. In this case it would still be necessary to at least remove groups from the list of supported options in the documentation, and code.
Ideally the functionality would be added back into the current version.
Additional Context
The text was updated successfully, but these errors were encountered:
It is done by AttributeGenerator, however USE imports are missing in the generated classes. Can anybody fix it? Or should I create PR (Im using this generator for the first time, it might take the time).
EDIT: I was able to fix it using following configuration
API Platform version(s) affected: 3.1.6 (Schema-generator version 5.2.0)
Description
The
groups
parameter no longer generatesGroups
attribute for properties as stated in the documentation.How to reproduce
The below config (excess removed) describes a referral resource that has one property
person
. APerson
has one propertyemail
. The normalization context of the post collection endpoint forReferral
has the serialization group set to "referral:post:write" (this works as expected). Theemail
property onPerson
has thegroups
option set toreferral:post:write
such that a person entity can be created from theReferral
collection post resource.Outcome:
When generating this schema, the
groups
option onPerson
is ignored. Looking through the code, it looks like the option is defined, but never used. This functionality used to work in version 4.0.1 throughApiPlatform\SchemaGenerator\AttributeGenerator\SerializerGroupsAttributeGenerator
. This functionality seems like it's no longer available, though it's still referenced in the documentation.Possible Solution
It is possible to set the Groups attribute using the
attributes
option, but this is a workaround. In this case it would still be necessary to at least removegroups
from the list of supported options in the documentation, and code.Ideally the functionality would be added back into the current version.
Additional Context
The text was updated successfully, but these errors were encountered: