Add documentation for terms_set minimum_should_match parameter #113043
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -159,12 +159,22 @@ GET /job-candidates/_search | |||||||||
| `terms`:: | ||||||||||
| + | ||||||||||
| -- | ||||||||||
| (Required, array) Array of terms you wish to find in the provided | ||||||||||
| `<field>`. To return a document, a required number of terms must exactly match | ||||||||||
| the field values, including whitespace and capitalization. | ||||||||||
|
|
||||||||||
| The required number of matching terms is defined in the `minimum_should_match`, | ||||||||||
| `minimum_should_match_field` or `minimum_should_match_script` parameters. Exactly | ||||||||||
| one of these parameters must be provided. | ||||||||||
| -- | ||||||||||
|
|
||||||||||
| `minimum_should_match`:: | ||||||||||
| + | ||||||||||
| -- | ||||||||||
| (Optional) Specification for the number of matching terms required to return | ||||||||||
| a document. | ||||||||||
|
Comment on lines
+174
to
+175
There was a problem hiding this comment.
Suggested change
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 |
||||||||||
|
|
||||||||||
| For valid values, see <<query-dsl-minimum-should-match, `minimum_should_match` parameter>>. | ||||||||||
| -- | ||||||||||
|
|
||||||||||
| `minimum_should_match_field`:: | ||||||||||
|
|
||||||||||
Oops, something went wrong.
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.
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.
Why remove "array of strings" here?
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.
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.