Question: how to make property non-required in GraphQl schema

[CvekCoding]

Hello!

I have an entity with method like addToLogs(LogEntity $logEntity).
Schema builder recognizes it like a property toLogs and makes it mandatory. How to solve this issue properly?

Thanks.

[CvekCoding]

I know I can change method name to addLog, and because of my entity has declaration of the property log as nullable the problem will be solved.
But the essence of my question is more common - how to make any property/method to be non-mandatory for graphql schema builder?

[alanpoulain]

You can use serialization groups to "hide" methods or properties:
https://api-platform.com/docs/core/graphql#serialization-groups

[CvekCoding]

@alanpoulain thanks for an answer.
Yes, I know about serialization groups, but what if I dont want hide the method/property, but only declare it like non-mandatory? I can do this for property - just put annotation like /** @var string|null */, but the same doesn't work for methods with "virtual" properties - annotation above method is ignored. Or I missed something?

[alanpoulain]

I think you have to make the parameter of the method nullable then. Either:
addToLogs(?LogEntity $logEntity) or addToLogs(LogEntity $logEntity = null)
You could also try to name it differently. insertToLogs(LogEntity $logEntity) for instance. Not sure about this.

[CvekCoding]

@alanpoulain, I tried both - doesn't work. Field is still mandatory.
I even tried this addToLogs(?LogEntity $logEntity = null) - just for fun:).

Yes, if I will not use one of special words "get", "add", "has", "is" , the method will not be recognized like a virtual property and schema builder just skip it.

But I think you answered my question - I have a few ways how to avoid this problem and I know that I didnt miss something. Hope this will be enough for me.

Thanks!

[CvekCoding]

But anyway may be this will be good if schema builder will respect method's annotations and parameters.

[alanpoulain]

I don't think it's an issue with the schema builder. Maybe with the property metadata factory.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.