Skip to content

Commit a70016a

Browse files
committed
TermsLookup fields should be marked as Required in docs (#53784)
The terms-lookup section of our terms query docs currently state that the index, id and path fields are optional. They should be marked instead as required.
1 parent adfeb50 commit a70016a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/reference/query-dsl/terms-query.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ GET /_search
2222
"query" : {
2323
"terms" : {
2424
"user" : ["kimchy", "elasticsearch"],
25-
"boost" : 1.0
25+
"boost" : 1.0
2626
}
2727
}
2828
}
@@ -93,16 +93,16 @@ To perform a terms lookup, use the following parameters.
9393
[[query-dsl-terms-lookup-params]]
9494
====== Terms lookup parameters
9595
`index`::
96-
(Optional, string) Name of the index from which to fetch field values.
96+
(Required, string) Name of the index from which to fetch field values.
9797

9898
`id`::
99-
(Optional, string) <<mapping-id-field,ID>> of the document from which to fetch
99+
(Required, string) <<mapping-id-field,ID>> of the document from which to fetch
100100
field values.
101101

102102
`path`::
103103
+
104104
--
105-
(Optional, string) Name of the field from which to fetch field values. {es} uses
105+
(Required, string) Name of the field from which to fetch field values. {es} uses
106106
these values as search terms for the query.
107107

108108
If the field values include an array of nested inner objects, you can access
@@ -117,7 +117,7 @@ when the document was indexed, this parameter is required.
117117
[[query-dsl-terms-lookup-example]]
118118
====== Terms lookup example
119119

120-
To see how terms lookup works, try the following example.
120+
To see how terms lookup works, try the following example.
121121

122122
. Create an index with a `keyword` field named `color`.
123123
+
@@ -246,4 +246,4 @@ field, {es} returns both documents.
246246
}
247247
----
248248
// TESTRESPONSE[s/"took" : 17/"took" : $body.took/]
249-
--
249+
--

0 commit comments

Comments
 (0)