Skip to content

Commit 927e208

Browse files
authored
[DOCS] Fix field caps API docs (#62110) (#62117)
1 parent 7d35dec commit 927e208

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/reference/search/field-caps.asciidoc

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
[[search-field-caps]]
2-
=== Field Capabilities API
2+
=== Field capabilities API
3+
++++
4+
<titleabbrev>Field capabilities</titleabbrev>
5+
++++
6+
37

48
Allows you to retrieve the capabilities of fields among multiple indices.
59
For data streams, the API returns field capabilities among the stream's backing
@@ -14,13 +18,13 @@ GET /_field_caps?fields=rating
1418
[[search-field-caps-api-request]]
1519
==== {api-request-title}
1620

17-
`GET /_field_caps`
21+
`GET /_field_caps?fields=<fields>`
1822

19-
`POST /_field_caps`
23+
`POST /_field_caps?fields=<fields>`
2024

21-
`GET /<target>/_field_caps`
25+
`GET /<target>/_field_caps?fields=<fields>`
2226

23-
`POST /<target>/_field_caps`
27+
`POST /<target>/_field_caps?fields=<fields>`
2428

2529

2630
[[search-field-caps-api-desc]]
@@ -46,6 +50,11 @@ To target all data streams and indices in a cluster, omit this parameter or use
4650
[[search-field-caps-api-query-params]]
4751
==== {api-query-parms-title}
4852

53+
`fields`::
54+
(Required, string)
55+
Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`)
56+
expressions are supported.
57+
4958
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
5059
+
5160
Defaults to `true`.
@@ -56,8 +65,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
5665
Defaults to `open`.
5766
--
5867

59-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
60-
6168
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
6269

6370
`include_unmapped`::

0 commit comments

Comments
 (0)