Add documentation for terms_set minimum_should_match parameter #113043
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
|
Documentation preview: |
elasticsearchmachine
added
needs:triage
kingherc
added
:Search/Search
elasticsearchmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-search (Team:Search) |
|
@elasticmachine test this |
|
run docs-build |
|
@pquentin approved the corresponding spec changes, does this look good to you? :) |
mark-vieira
added
auto-backport
pquentin
approved these changes
Oct 17, 2024
| (Required, array of strings) Array of terms you wish to find in the provided | ||
| (Required, array) Array of terms you wish to find in the provided |
There was a problem hiding this comment.
Why remove "array of strings" here?
There was a problem hiding this comment.
See the PR description. The elements are not restricted to string, but can be anything parsable to a field value, including JSON “number” types. Documenting as “array of strings” is incorrect and misleading.
Comment on lines
+174
to
+175
| (Optional) Specification for the number of matching terms required to return | ||
| a document. |
There was a problem hiding this comment.
Suggested change
| (Optional) Specification for the number of matching terms required to return | |
| a document. | |
| (Optional, integer) Specification for the number of matching terms required to return | |
| a document. |
There was a problem hiding this comment.
Restricting to “integer” is incorrect. The value can be anything described on the linked documentation page, some of which are integers, but also many of which are strings with very specific formats:
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html
pquentin
approved these changes
Oct 20, 2024
💔 Backport failedThe backport operation could not be completed due to the following error: You can use sqren/backport to manually backport by running |
davidkyle
pushed a commit
to davidkyle/elasticsearch
that referenced
this pull request
Oct 24, 2024
leemthompo
pushed a commit
to leemthompo/elasticsearch
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7)
leemthompo
pushed a commit
to leemthompo/elasticsearch
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7)
leemthompo
pushed a commit
to leemthompo/elasticsearch
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7)
leemthompo
pushed a commit
to leemthompo/elasticsearch
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7)
leemthompo
pushed a commit
to leemthompo/elasticsearch
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7)
This was referenced Oct 24, 2024
leemthompo
pushed a commit
to leemthompo/elasticsearch
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7)
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
leemthompo
pushed a commit
to leemthompo/elasticsearch
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7)
elasticsearchmachine
pushed a commit
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7) Co-authored-by: mspielberg <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7) Co-authored-by: mspielberg <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7) Co-authored-by: mspielberg <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Oct 24, 2024
(cherry picked from commit 28715b7) Co-authored-by: mspielberg <[email protected]>
georgewallace
pushed a commit
to georgewallace/elasticsearch
that referenced
this pull request
Oct 25, 2024
jfreden
pushed a commit
to jfreden/elasticsearch
that referenced
this pull request
Nov 4, 2024
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.
Elasticsearch has supported the
minimum_should_matchparameter for theterms_setquery since 8.10.0 (PR #96082). As mentioned in the original issue ticket (#94095) the additional parameter is not currently documented, so this PR adds documentation.This PR also removes the incorrect documented constraint that the
termsparameter must consist solely of strings. In fact each term can be any valid FieldValue, as in the normaltermsquery.For example, when querying against a field mapped as type
datethe term may be specified with a JSON number as described at (https://www.elastic.co/guide/en/elasticsearch/reference/8.15/date.html).