Hi there,
at bulkOperationRunQuery - GraphQL Admin, we can see how the ‘groupObjects’ argument is required and has default value at the same time.
Please could you take a look?
Hi @sinuhe Good catch - the docs are showing groupObjects as both “required” and having a default value, which doesn’t make sense.
Having intorspected the schema, groupObjects is optional. It defaults to false, so if you omit it entirely your bulk operation returns flat JSONL (no grouping).
I’m raising this with the docs team to get the “required” badge removed. I’ll update this thread once I hear back from them. Thanks for flagging!
1 Like
Quick update on this one @sinuhe: In GraphQL, Boolean! means the type is non-null (you can’t pass null as a value), which is what triggers the “required” badge in our docs. But the argument also has a default value of false, so if you omit it entirely the server uses that default.
So technically it’s “required” from the schema’s perspective (must be a non-null Boolean when provided), but optional from your perspective as a developer (you can skip it and get the default).
You’re right that showing both badges together is confusing though. I’ve raised this with the docs team and there’s an active discussion about whether to hide the “required” badge when a default value exists, since from a practical standpoint an argument with a default isn’t something you need to worry about providing. I’ll update this thread if anything changes!
1 Like