[Query Rules] clarify query rules API documentation #100732
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kderusso
added
>docs
|
Documentation preview: |
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/ent-search-eng (Team:Enterprise Search) |
kderusso
added
auto-backport-and-merge
and removed
Team:Docs
leemthompo
reviewed
Oct 12, 2023
leemthompo
reviewed
Oct 12, 2023
| @@ -109,8 +109,8 @@ The following example creates a new query ruleset called `my-ruleset`. | |||
|
|
|||
| Two rules are associated with `my-ruleset`: | |||
|
|
|||
| - `my-rule1` will pin documents with IDs `id1` and `id2` when `user.query` exactly matches `marvel` _or_ `dc` **and** `user.country` exactly matches `us`. | |||
| - `my-rule2` will pin documents from different, specified indices with IDs `id3` and `id4` when the `query_string` fuzzily matches `comic`. | |||
| - `my-rule1` will pin documents with IDs `id1` and `id2` when `user_query` contains `pugs` _or_ `puggles` **and** `user_country` exactly matches `us`. | |||
There was a problem hiding this comment.
Why the switch from dot notation here? (e.g. user.query -> user_query)
There was a problem hiding this comment.
The feedback was that all of our examples should be consistent. So since we were using user_query everywhere else, it was easier to update this one document over the others.
|
Looks good, but I'll defer to team for technical 👁️ 🔍 |
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
kderusso
added a commit
to kderusso/elasticsearch
that referenced
this pull request
Oct 13, 2023
* Update example in query rules docs * Ensure GET docs are also consistent * Update docs/reference/query-rules/apis/put-query-ruleset.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
kderusso
added a commit
to kderusso/elasticsearch
that referenced
this pull request
Oct 13, 2023
* Update example in query rules docs * Ensure GET docs are also consistent * Update docs/reference/query-rules/apis/put-query-ruleset.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Oct 13, 2023
* Update example in query rules docs * Ensure GET docs are also consistent * Update docs/reference/query-rules/apis/put-query-ruleset.asciidoc --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Oct 13, 2023
* Update example in query rules docs * Ensure GET docs are also consistent * Update docs/reference/query-rules/apis/put-query-ruleset.asciidoc --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We received feedback that different examples of
match_criteriain various parts of the query rules documentation was confusing. This PR streamlines the examples in our query rules documentation (APIs, rule query and search guide).