[4.x]: Pass search options via GraphQL

[janhenckens]

What happened?

Description

I'm trying to query a GraphQL endpoint on a site running Craft 4.13.7 and I'd like to override the defaultSearchTermOptions in my query.

In Twig we can do this:

{% set entries = craft.entries()
  .section('mySection')
  .search({
    query: 'salty dog',
    subRight: false,
  })
  .all() %}

When I try to pass a similar query via GraphQL

search: [{query: "salty dog"}, {subRight: false}]

That returns the following error:

{
  "errors": [
    {
      "message": "Field \"entries\" argument \"search\" requires type String, found [{query: \"salty dog\"}, {subRight: false}].",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 35,
          "column": 13
        }
      ]
    }
  ]
}

Thanks for taking a look!

Craft CMS version

4.13.7

PHP version

8.1

Operating system and version

No response

Database type and version

No response

Image driver and version

No response

Installed plugins and versions

[krafttoast]

@janhenckens try to pass it in the following way:

search: "[{query: \"salty dog\"}, {subRight: false}]"

make sure you escape the double quotes properly

[brandonkelly]

It’s not possible to accept scalar values and objects by the same query param, so this will require a new searchTermOptions argument. Added for 4.15 and 5.7: #16979

[janhenckens]

Thanks for adding this @brandonkelly, that has us covered for the feature we're building 👍

[brandonkelly]

Craft 4.15.0 and 5.7.0 are out with that new argument.