New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update intro-to-graphql.md #3626
Conversation
Added explanation about search operators
💥 No ChangesetLatest commit: 555d137 Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂 If these changes should be published to npm, you need to add a changeset. This PR includes no changesetsWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Click here to learn what changesets are, and how to add one. Click here if you're a maintainer who wants to add a changeset to this PR |
Looks like i don't need a changeset for docs? |
docs/guides/intro-to-graphql.md
Outdated
@@ -308,7 +308,7 @@ query { | |||
|
|||
### `search` | |||
|
|||
Will search the list to limit results. | |||
Will search the list to limit results. It can search only by [labelField](/docs/api/create-list.md#labelfield). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't quite true. At the moment the search
is applied to a Text
field called name
. This is not currently configurable, although that is a feature which is on our backlog.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@timleslie I changed it to:
"For now, it can search only by name
field. The name
field must be a Text
type."
👇👇
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Thanks @zamkevich, this will hopefully clear things up a bit for readers of this documentation.
Added explanation about search operators